Hinweise zum Vereinheitlichen von Java-Kommentaren bei Verwendung von Doxygen
test.java
/*
*
* @Title : ${PACKAGE_NAME}
* @Description:
* @company : ** corp
* @history : Created by ${USER} on ${DATE}.
*
*/
public class ${PACKAGE_NAME} {
/* constractor */
${PACKAGE_NAME} () {
...
}
...
}
Fügen Sie das Obige in die Vorlage ein und geben Sie es beim Erstellen der Klasse automatisch ein. Geben Sie den Klassennamen in @Title ein Beschreiben Sie den Umriss der Klasse in @Description Beschreiben Sie den Ersteller oder die Firma in @company Geben Sie das Erstellungs- oder Änderungsdatum in @history ein
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)
{
...
}
Die Methode ist in @brief beschrieben Beschreibt die Details des Parameters @param. Es ist im Nachbearbeitungsprozess leicht zu verstehen, wenn Sie beschreiben, welche Art von Daten und in welchem Bereich sie sich befinden. @return Geben Sie den Rückgabewert ein. Dies ist auch leicht zu verstehen, wenn Sie die Art und den Bereich der Daten beschreiben.
Registrieren Sie es im Tool zur Kommentargenerierung, damit Sie es automatisch ausfüllen können. Persönlich ist Visual Studio Code gut.
Anstatt Zeile für Zeile zu schreiben, schreiben Sie in Ausführungseinheiten.
test.java
// @summary The Name property ...
Für mich lassen Sie die Kommentare so locker Der Rest ist eine Gruppe, die mit der Einstellung von Doxygen verwaltet
Recommended Posts