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

Post a Comment

Popular posts from this blog

MySql variables and php -

-
I am getting an error with php in order to format mysql_query () in php to format this string What is the right way? SELECT SELECT SELECT (*) Agents @AgentCount; User_Agent_English, User_Angent_Oursal, US.___Gent_Aginal, COUNT (User_Agent_Percade) ACC, COUNT (*) / (AgentCount) Percentage by agents user_agent_preser order DEC limit limit 50; In PHP, how am i setting $ query $ query = "SELECT count (*) agents @ agentcount; SELECT user_agent_parsed, User_agent_original , COUNT (user_agent_parsed) ascount, COUNT (*) / (@AgentCount) as a percentage by user_agent_parced by URI date DESC limit 50 "; This exact query will work properly if I put it in MySQL directly through a command line session. Do I need to release two separate php calls from mysql_query () and store the results first? I get the following error: There is an error in your SQL syntax; Instead of using a sub-selection and instead of using the 'SELECT user_agent_parsed, user_agent_original, ne...
Read more

url rewriting - How to implement the returnurl like SO in PHP? -

-
This URL should work even after the rewrite. Is this possible? Otherwise, I can only hardcoded everything If you are trying to create a login system with redirection You need to use the HTTP_REFERER header to find out where the user came from so that you can send it back there. The best way to do this is to use something like this in your login form: // - Login php & Lt; Input type = "password" name = "password" /> & Lt; Input type = "hidden" name = "returnrelale" value = "& lt ;? php echo $ redirectURL ;? & gt;" / & Gt; & Lt; / Form & gt; Please note that some ISP, browser or proxy will delete the referrer header, so you can not rely on each user to work fully. If you use a statement, to check whether the header exists or not, you can send those users back to the homepage or whatever. Edit If you are looking to use $ _SERVER ['REQUEST_URI'], if you are running Apache It sho...
Read more

Which Python client library should I use for CouchdB? -

-
I am starting to experiment with CouchDB because it looks like we have the right solution to certain problems That all the work will be on a new project, which does not have any legacy dependency, which the client library will suggest you use, and why? If we overlap any of the OS. Freeband is available only in the collection of its ports, but asks to use the library's project website. None of those people are Ubuntu, which is only with ships, since those two OSAs are not common in libraries, I am probably installing something from source (and hopefully if I have time, then Ubuntu and FreeBSD People pack the package). For those interests, I want to use CouchDB as a convenient intermediate storage space for data passed between different services - think of a message bus system, but less formalities with. For example, we have daemons that download and pars the web page, then send an interesting bit to other daemons for further processing. Many of them are ill-defined until the...
Read more