개인 회원 및 무료 기능에 대한 Doxygen 설명?

Question

개인 회원 및 무료 기능에 Doxygen 설명을 사용해야합니까? 자바 세계에서 왔고 개인 회원을 위해 Javadoc을 추가하지 않았습니다. 이것은 C++ 세계에서 수용 가능한 관행인가?

Answer 1

꽤 많은 언어 독립 문제라고 말할 수 있습니다. 문서화하고자하는 회원을 문서로 작성하십시오.

Answer 2

설명서 대상 독자에 따라 다릅니다. 일반 공개의 경우에는 아니요, 개인 및 내부 변수에 대해 알 필요가 없습니다.

내부 용으로 사용하는 경우 개인 변수 및 무료 기능 사용에 대해 반드시 알아야합니다.

Answer 3

개인 기능을 문서화 할 수 있으며 @internal을 사용하여 공개 및 개발자 문서를 제공합니다.

또한 구현이 사용자에게 표시되지 않는 개인 구현 실습을 사용합니다.