开发者

Doxygen comments for private members and free functions?

Should I use Doxygen comments for private members and free functions? I come from the Java world, and I never added Javadoc for private members. Is开发者_C百科 this an acceptable practice in the C++ world?


Depends on the documentation target audience. If it's for public release, then no, they don't need to know about private and internal variables.

If it's for internal usage, then yes, they surely need to know about the usage of private variables and free functions.


I'd say it's pretty much language independent issue. You document members you want to have documented.


You can document private functions - we do and use @internal to provide public and developer documentation.

We also use a private implementation practice where implementations are hidden from the user.

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜