Sollte ich Doxygen Kommentare für private Mitglieder und kostenlose Funktionen verwenden? Ich komme aus der Java-Welt und habe Javadoc nie für private Mitglieder hinzugefügt. Ist das eine akzeptable Praxis in der C++ - Welt?Doxygen Kommentare für private Mitglieder und freie Funktionen?
Ich würde sagen, es ist ziemlich sprachunabhängig Problem. Sie dokumentieren Mitglieder, die dokumentiert werden sollen.
Hängt von der Zielgruppe der Dokumentation ab. Wenn es zur Veröffentlichung freigegeben ist, dann müssen sie nicht über private und interne Variablen Bescheid wissen.
Wenn es für den internen Gebrauch ist, dann ja, sie müssen sicherlich über die Verwendung von privaten Variablen und freien Funktionen wissen.
Sie können private Funktionen dokumentieren - wir verwenden und verwenden @internal, um öffentliche und Entwickler-Dokumentation bereitzustellen.
Wir verwenden auch eine private Implementierungspraxis, in der Implementierungen vor dem Benutzer verborgen sind.