Remarques sur l'unification des commentaires Java lors de l'utilisation de Doxygen
test.java
/*
*
* @Title : ${PACKAGE_NAME}
* @Description:
* @company : ** corp
* @history : Created by ${USER} on ${DATE}.
*
*/
public class ${PACKAGE_NAME} {
/* constractor */
${PACKAGE_NAME} () {
...
}
...
}
Mettez ce qui précède dans le modèle et entrez-le automatiquement lors de la création de la classe. Entrez le nom de la classe dans @Title Décrivez le plan du cours dans @Description Décrivez le créateur ou l'entreprise dans @company Saisissez la date de création ou de modification dans @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)
{
...
}
La méthode est décrite dans @brief Décrit les détails du paramètre @param. Il est facile de comprendre dans le post-processus si vous décrivez le type de données et leur plage. @return Entrez la valeur de retour. Cela est également facile à comprendre si vous décrivez le type et la plage de données.
Enregistrez-le dans l'outil de génération de commentaires afin de pouvoir le remplir automatiquement. Personnellement, Visual Studio Code est bon.
Au lieu d'écrire ligne par ligne, écrivez en unités d'exécution.
test.java
// @summary The Name property ...
Pour moi, laissez les commentaires si lâches Le reste est un groupe qui gère avec le cadre de Doxygen
Recommended Posts