documentation - Where are doxygen comments appropriate/necessary? -


I do not have much experience with Docs tools like Docs, so I'm not sure exactly the in-code documentation < Em> should look.

Should I write a doxygen-style comment for each member variable in the class? Or is it overhead if the variable names are quite self explanatory?

Should I include comments from the title in the respective implementation file? I have not made any guesses, because changing one's comments in one file will make one change to another; But it will certainly be convenient for the developers working on the implementation because the headers file is not consulted to know the purpose of a given method.

Should I write a doxygen-style comment for each member variable in the class? Or is it overhead if the variable names are quite self explanatory?

This is at least partially the issue of a style, different people do it differently.

I think that either a public or protected should be documented, as is your class API, protected API Part of what you can give to someone who can enhance your class).

For some methods this can be simplified when the method is simple, setters. I still document them, but if this is not possible then maybe this is not a big deal. However, if you do not include documentation for everything, make sure that Docsis is configured for the output documents of each document, not just fields / methods of documents, otherwise without documenting methods and fields in output Will not be visible.

Should I include comments from the header in the respective implementation file? I have not made any guesses, because changing one's comments in one file will make one change to another; But of course, it will be convenient to work on the implementation of developers, not to consult the header file to know the purpose of a given method.

Write the documentation only once is the purpose of Doxygen-style comments so that the person using the class is not to see the code (header file or otherwise) Em>. They will see the documentation generated by Doxygen, which will be well formatted and linked. As long as your documentation comments are useful, it is easy to go through the Dosageogen output code and to use instead of viewing.


Comments

Popular posts from this blog

asp.net - Javascript/DOM Why is does my form not support submit()? -

sockets - Delphi: TTcpServer, connection reset when reading -

javascript - Classic ASP "ExecuteGlobal" statement acting differently on two servers -