Wie kommentiert ihr objc Code?

[Tobias Scholze]

Servus,
ich wollte einmal fragen, wie ihr euren objc Code kommentiert.

Irgendwie hab ich noch keine so richtigen "Guidelines" entdeckt. Ich komme ursprünglich aus der Java, C# Welt und dort gibt es eben strikte Vorgaben die szu tun, damit diese Inline als Hilfetext und Co. verwendet werden können.

Habt ihr ein Best Practice oder so?

LG, Tobi

 

[commune10]

Ich mach das im doxygen style ( http://www.stack.nl/~dimitri/doxygen/index.html ), weil man am Ende sowohl eine recht brauchbare Onlinehilfe als auch ein gutes pdf bekommt. Mein Eindruck ist, das Apple auch ein wenig von headerdoc in Richtung doxygen geht.

 

[Tobias Scholze]

Hi,
danke für deine Antwort. Aber das sagtr aus, das Apple hier keine ahrte Konvention vorgibt wenn man mit 3rd Party Docgeneratoren arbeiten "muss". Oder?

LG, Tobi

 

[commune10]

Wieviel Inline-Doku ist ja so ein bisschen Glaubensfrage. So wie die einen Emacs und die anderen Vim sagen, nutzen die einen Inline-Dokus intensiv und die anderen gar nicht. Apple gibt da nichts vor, ich persönlich mag umfangreiche Dokus.

HeaderDoc ist ja von Apple, http://en.wikipedia.org/wiki/HeaderDoc so gesehen gibt Apple schon was vor, aber wie gesagt, Doxygen hab ich das ein oder andere mal auch schon bei Apple gesehen. So groß sind die Unterschiede ja auch nicht, HeaderDoc unterstützt die Doxygen-Syntax sogar in Teilen. Doxygen kann halt TeX-Documente erzeugen, was für mich das Killerfeature ist. Außerdem mag ich die Call-Graphen, die via graphviz erzeugt werden. Das hat natürlich auch alles seine Grenzen, aber mir gefällts im wesentlichen. Ansonsten steht HeaderDoc aber auch nicht schlecht dar. Schau dir mal die Vergleichstabellen an: http://en.wikipedia.org/wiki/Comparison_of_documentation_generators