Doxygen comments on declarations or on definitions?
Posted
by Arkaitz Jimenez
on Stack Overflow
See other posts from Stack Overflow
or by Arkaitz Jimenez
Published on 2009-11-23T10:29:33Z
Indexed on
2010/05/29
13:22 UTC
Read the original article
Hit count: 239
Just started using Doxygen for documenting my code here and can't decide where to put them.
At first look it seems better to put them in the declaration files as it is there where you actually declare what you receive, what you are going to return and stuff like that, apart from that things like data members that are only in the declaration files can obviously only documented there.
But often I find handier to comment methods in the implementation files as they are more accessible to me and the declaration file doesn't get cluttered with dozens of lines of comments making it harder to find what you look for when developing.
What is your experience with that?
© Stack Overflow or respective owner