2012-04-14 12 views
-2

Glaubst du, dass es Code kommentieren muss, es sei denn, es handelt sich um eine API?Kommentarcode AS3 - Keine API sein

Ich meine, ein guter Code. Mit selbsterklärenden Variablen und Methoden.

Sie müssen einen guten Code kommentieren?

Danke.

+0

Sie sollten dies zu http://programmers.stackexchange.com/ nehmen, da es sich um eine allgemeine Programmierfrage handelt, die nicht so sehr auf ein bestimmtes Problem bezogen ist. – weltraumpirat

Antwort

1

Es ist eine gute Frage, aber auch sehr subjektiv. Wenn Sie sehr soliden Code schreiben und eine gut gestaltete Anwendung haben, wird fast jeder Teil davon selbsterklärend sein (selbstdokumentierend). Aber fragen Sie sich, ob das wirklich der Fall ist, bevor Sie Kommentare ablehnen.

Das heißt, gute Kommentare oft klären die größere Absicht von Stücken von Code, Pakete, Klassen; Sie geben einen Überblick über das, was Sie tun, anstatt nur ein paar Zeilen zu "erklären". Und natürlich ist es hilfreich, einen Kommentar zu Codeelementen (komplizierte Algorithmen) zu schreiben.

Wie auch immer, Sie müssen Ihren Code nicht mit Kommentaren verseuchen, wenn er nur für den privaten Gebrauch bestimmt ist und der Umfang Ihres Projekts begrenzt ist. Platzieren Sie Kommentare einfach intuitiv, wenn Sie der Meinung sind, dass dies geklärt werden muss. Sie werden oft froh sein, wenn Sie später zu einem Code zurückkehren und ihn ändern müssen.