A note on unifying java comments when using Doxygen
test.java
/*
*
* @Title : ${PACKAGE_NAME}
* @Description:
* @company : ** corp
* @history : Created by ${USER} on ${DATE}.
*
*/
public class ${PACKAGE_NAME} {
/* constractor */
${PACKAGE_NAME} () {
...
}
...
}
Put the above in the template and enter it automatically when creating the class. Enter the class name in @Title Describe the outline of the class in @Description Describe the creator or company in @company Enter the date of creation or modification in @history
test.java
/**
* @brief This function is called by the application to add ...
* @param len Length
* @param data Data
* @param src Src
* @return result
* @since ticket no.
*/
private bool storeData(int len, int data, int src)
{
...
}
The method is outlined in @brief Describes the details of the @param parameter. It is easy to understand in the post-process if you describe what kind of data and what range it is. @return Enter the return value. This is also easy to understand if you describe the type and range of data.
Register it in the comment generation tool so that you can fill it out automatically. Personally, Visual Studio Code is good.
Instead of writing line by line, write in execution units.
test.java
// @summary The Name property ...
For me, leave the comments so loose The rest is a group that manages with Doxygen settings
Recommended Posts