Diese Art der Kommentierung ist äußerst wertvoll in einer Umgebung mit mehreren Entwicklern, in der es eine Reihe von Fähigkeiten und/oder Geschäftswissen über die Entwickler gibt (z. B. - überall).
Für den erfahrenen Entwickler kann der Grund für eine Änderung offensichtlich sein, aber für neuere Entwickler wird dieser Kommentar sie dazu bringen, zweimal nachzudenken und weitere Untersuchungen durchzuführen, bevor sie damit fertig werden. Es hilft ihnen auch, mehr darüber zu erfahren, wie das System funktioniert.
Oh, und eine Notiz aus Erfahrung über die „Ich habe das nur im Quellkontrollsystem“ Kommentare:
Wenn es nicht in der Quelle ist, ist es nicht der Fall war.
ich nicht die Anzahl, wie oft die Quelle der Geschichte für Projekte mit der Source-Control-Software, falsche Verzweigung Modelle usw. verloren wurde aufgrund von Unerfahrenheit zählen Es ist nur einen Ort, der Geschichte ändern nicht verloren - Und das ist in der Quelldatei.
ich es in der Regel dort die erste Stelle setzen, dann schneiden ‚n den gleichen Kommentar einfügen, wenn ich überprüfen Sie es in.
Sie sind völlig richtig. Ich erinnere mich an eine Methode in unserem Code, die nur aus Bug-Fixes zu bestehen scheint (bezüglich der Art der oben erwähnten Kommentare)! –
Was ist ein Tracking-System-Repository? –
Als ich "Tracking-System und Repository" erwähnte, bezog ich mich auf zwei Dinge. Eine, ein Bug-Tracking-System, wie Bugzilla oder JIRA, wo Sie Kommentare zu einem Problem stellen können. Zweitens, ein Quellcode-Repository wie SVN oder Git, wo Sie Kommentare mit Commits setzen können. –