Geek asks and answers

Commenting on C Standards

I work with a team called Solar Jackets at Georgia Tech, and we had a "comment crisis." We have many members who finish their studies and leave the code without comment. I am looking to implement a standard for comments, so this does not happen, and I need some suggestions to make sure all my databases are included.

I want to use the following functions:

  • A unified place where you can view a description of all functions, including inclusions, arguments, return types, and a general description of the code. (generated from comments in code)

  • In the code itself, a description of line by line (or next to).

Are there any suggestions that I may have forgotten? Are there any programs that can automatically generate code compilation? How could I make this easier for programmers?

+3
source share
4 answers

what you described reminds me of Doxygen. It has a format for commenting on all objects in the code, including functions, parameters, variables, ... It can be used to enforce everything that has been registered by checking the alerts generated by Doxygen. It generates a complete document with source code in various formats such as HTML, Latex, PDF, ...

Many IDEs know Doxygen tags and can be integrated with Doxygen to help the developer comment on the code.

here is an example of a Doxygen comment:

/**
 * @brief This function does blah blah.
 * @param test blah blah parameter.
 * @return 0 if blah blah passed.
 */
uint32_t TestFunction( uint32_t test )
{
    return 0;
}
+8
source

, , , . , , , . , .

+2

, , . . , .., .

, , , . , , #defines , .

+1

.

  • , , .
    • .. , .
    • , .
    • , ; .
  • , , .
  • , ( static, , ?).
  • , ( ).
  • (, ).
  • , .

, .

, , , . , 1990 – : ndash; - 1990 , " ". , 7 ; , . , , . . ? , , , , . , , , ( , , , ). , 30 () , , - .

, , , , . , , , , , , , . , ! , , , .

+1

More articles:


All Articles