Für die Dokumentation müssen wir normalerweise ein zusätzliches Dokument erstellen, das beschreibt, was wir gemacht haben, als Flusennachrichten im Code (e.g. /* lint --e228)
deaktiviert wurden.
Es würde es viel einfacher machen, es mit doxygen
zu benutzen (wie wir das sowieso erstellen).
Allerdings konnte ich mit diesen lint Kommentaren keine Lösung finden, wie doxygen
erstellt werden kann.
Hat jemand das versucht?
Gibt es eine Lösung wie stric '/*lint'
zu verwenden ist, aber irgendwie zu doxygen
hinzufügen?
Danke!
Dies kann erreicht werden, indem ein Makro definiert wird, das in den Kommentar des Lint-Ausdrucks erweitert wird, das Makro jedoch in einen anderen Kommentar erweitert wird, wenn es um doxygen
erweitert wird.
Der Trick besteht darin, die Anweisung -save
für PC-lint TM oder FlexeLint TM zu verwenden:
Dann können Sie in Ihrer Konfigurationsdatei doxygen
die Erweiterung bestimmter Präprozessormakros aktivieren. Insbesondere können wir LINT_CONTROL
ändern, um stattdessen in einen doxygen
-bezogenen Kommentar zu expandieren.
Alternativ können Sie, wenn Sie FlexeLint TM haben, die umhüllte Quelle so ändern, dass ein Doxygen-Kommentar zum Auslösen des Lint-Steuerelements verwendet werden kann. Die Technik wird im Gimpel Software-Diskussionsforum beschrieben.
PC-Lint und FlexeLint sind Marken von Gimpel Software.
Tags und Links c doxygen lint documentation code-comments