Voriger BeitragNächster Beitrag
Übersicht
Antworten
08.12.2011 11:07

Re: Schöner Werbetext

Richard


Wir benutzen git und Redmine, IDE ist jedem Entwickler so weit selbst
überlassen.


Hier ist das die Kombination Redmine/SVN, ansonsten siehts ähnlich aus.

Was ich meinte war aber eher der Link in dem Docblock zum
Ticket oder der Doku.


Vermutlich reden wir gerade aneinander vorbei aber: Wozu brauchst Du in der API-Dokumentation (ich nehme mal an das meinst mit dem "Docblock") Hinweise auf Revisionen oder Tickets?

Wenn ich die API-Doku lese, will ich eigentlich wissen, was die jeweilige Funktion macht und wie ich sie benutzen kann, aber nicht
wer das Feature wann angefordert hat (Ticket) oder wann der letzte Bugfix eingespielt wurde (Revision). Das gehört in die zugehörigen Release-Notes.

Das einzige, was mir dazu einfällt wäre ein Hinweis darauf, seit wann ein bestimmtes Feature so wie dokumentiert enthalten ist - das wäre dann aber eigentlich eher ein (typischerweise manuell angelegter) Verweis auf ein *Release* statt auf eine Revision oder ein Ticket, oder?

Was ich eigentlich meinte ist das Tracking, welche Zeile des
aktuellen Quellcodes aus welcher Revision kommt - und da liefert mir meine IDE (Netbeans, ich kann mir aber nicht vorstellen daß Eclipse oder andere das nicht bieten) mit "Show Revision Annotations" alles was ich brauche. Und selbst wenn die IDE das nicht können sollte, der Repository-Browser in Redmine kann das.

Oder kennst Du da etwas das das irgendwie automatisch
erledigen könnte? Ich wüßte da jetzt nicht mal wie das gehen
sollte.


Für Subversion könnte man die "Keyword Expansion" nehmen (ersetzt speziell formatierte Strings durch entsprechende Metadaten, in der
Art von "$Rev$" -> "$Rev: 12345$"). Ob es für git was entsprechendes gibt weiß ich nicht, aber git kennt ja Hooks, damit kann man sich sowas mit basteln wenn man es denn unbedingt braucht. Ist aber in jedem Fall ein Krücke und nervt meistens mehr als es nützt (z.B. weil ein "diff" zwischen zwei Revisionen dann neben den eigentlich interessanten Änderungen noch jede Menge irrelevanten Quark zu geänderten Revisions-Kommentaren zeigt).


Ich nehme an Du kennst das? ;)

http://asiapac.com.au/images/THE_SOFTWARE_DEVELOPMENT_PROJECT.jpg


Natürlich :-)
Beitrag
Voriger BeitragNächster Beitrag
Übersicht
Übersicht
Antworten
Antworten

Zurück zu: Clean Code Developer aus Unternehmenssicht – ein Anwenderbericht

Copyright © 2013 Heise Zeitschriften Verlag