Use the JavaDoc/Doxygen format (see examples below) so that code documentation can be generated automatically. All nontrivial functions should have a comment above them explaining what the function does, even if it is just one sentence. All structures and their member variables should be documented, too.
Avoid Qt-style and similar Doxygen syntax with ! in it, i.e. replace //! with /// and similar. Also @ syntax should be employed for markup commands, i.e. use @param and not \param.
/**
* @file
* MPEG codec.
* @author ...
*/
/**
* Summary sentence.
* more text ...
* ...
*/
typedef struct Foobar {
int var1; /**< var1 description */
int var2; ///< var2 description
/** var3 description */
int var3;
} Foobar;
/**
* Summary sentence.
* more text ...
* ...
* @param my_parameter description of my_parameter
* @return return value description
*/
int myfunc(int my_parameter)
...
标签：...,ffmpeg,sentence,int,my,Comments,parameter,description From： https://www.cnblogs.com/sathcal/p/18537788