Guck dir das obligatorisch-typische Spiel auf einer Makerengine an:Zitat
Erklären den einfachsten Doofmist und tun's genau dann nicht, wenn's mal von Nöten wäre.
Es überträgt sich sozusagen von hinter auf vor die Kulissen.
Guck dir das obligatorisch-typische Spiel auf einer Makerengine an:
Erklären den einfachsten Doofmist und tun's genau dann nicht, wenn's mal von Nöten wäre.
Es überträgt sich sozusagen von hinter auf vor die Kulissen.
--
Solange es hier falschzitierende Ärsche gibt, dulde ich keinerlei Zitatboxen, die von mir sein sollen.
Für simple Funktionen ist es simpel einen Kommentar zu schreiben.
Eine komplizierte Funktion welche man mit nur viel Denkarbeit und Trial&Error schreiben konnte ist hingegen schwer zu kommentieren, vor allem wenn man nicht sofort kommentiert nachdem man die Funktion geschrieben hat sondern erst im Nachhinein.
Generell bevorzuge ich sehr einfach verständliche und konsequente Namensgebung für Variablen und Methoden beizubehalten, sodass man die meisten Methoden nicht kommentieren muss.
Was man kommentieren sollte sind Ausnahmefälle, Vorbedingungen für die Ausführung einer Funktion, Schleifeninvarianten (bei komplexen Schleifen), oder wenn man gewisse Schritte zur besseren Effizienz "weniger" übersichtlich schreibt weil es sich um eine kritische Funktion handelt.
Außerdem, wenn die Bibliothek veröffentlicht werden soll, liebe ich es immer wenn in die Kommentare auch geschrieben wird, ob es sich um eine heavy- oder lightweight Methode handelt.
Eine Kommentarmethode , die sich bei mir im Job und im Maker bewährt hat:
Ich beschreibe als Text vollständig was die Funktion machen soll. Bevor ich auch nur eine Zeile Code tippe. Wenn die Funktion fertig ist muss ich nur noch den Text zerstückeln und verteilen ;-)
--CortiWins GitHub DynRPG < Charguide < [2k3] Zahlen und Werte < [2k3] Kurven als Wertetemplates < [2k3] DynRPG Werkstatt
▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬ஜ۩۞۩ஜ▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬
Hello from the otter side
▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬ஜ۩۞۩ஜ▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬
Und vor der Kommentarmethode wird es, wie es sich gehört brav ein Ablaufdiagramm erstellt.
Ablaufdiagramme sind überbewertet. Aber ich hab schon mindestens eine Doku für meine Eventscripts geschrieben.Und vor der Kommentarmethode wird es, wie es sich gehört brav ein Ablaufdiagramm erstellt.
--"Diese Divs sind magische Wesen."
HTML = schwarze Magie?
Ich meinte das auch sarkastisch ... ich kann mich nie wirklich mit diesen Dingern anfreunden. Ich mach sie sowieso nie, einfache Notizen sind da schon das Maximum. ^^
Ach lass mir meinen Spaß. xD
Und Kommentare haben auch den Vorteil, dass man sie vorm Release rauslöschen kann.
--"Diese Divs sind magische Wesen."
HTML = schwarze Magie?
Kommentare vor dem Release zu löschen verfehlen meiner Meinung nach ihren Sinn und Zweck. Außer du meintest in Form von persönlichen Notizen, was aber dann keine richtigen Kommentare wären (zumindest nicht in richtigen Programmen und im Makerspielen ist es ja eh egal, was drinsteht. Das liest sich kein Mensch durch ^^).
PAP, Nassi-Shneiderman und wie sie nicht alle heißen - ich bin auch kein großer Freund davon. Ich persönlich denke aber, dass sie bei komplexen Projekten durchaus Sinn machen. Ein paar kleinere Notizen oder MindMaps mache ich doch durchaus manchmal - wenn auch sehr selten xD
Und naja, Kommentare vor Release zu löschen wäre in meinen Augen - gerade bei einem Makerspiel - mehr Aufwand als Nutzen. Immerhin muss man sich dann durch jedes einzelne EventScript quälen und die Kommentare suchen und herauslöschen.
PeAcE
MorDen
--»Ein Traum kann auch die Wehmut nach der verlorenen Vergangenheit sein…«
»Manchmal ist eine Enttäuschung auch einfach nur das Ergebnis zu hoher Erwartungen.«
__________________________________________________________________________
Wenn dein Code gut ist, dann hast du da nicht so viel, wo du durchscrollen musst.
--"Diese Divs sind magische Wesen."
HTML = schwarze Magie?
Ich glaub so einfach hätten wirs alle gerne, aber darüber reden wir am besten nochmal, wenn du dein erstes, eigenes Action-KS skriptest, das vom Umfang und der Komplexität über auf-Gegner-zurennen-und-Enter-drücken hinausgeht.
Wenn man sich vorher Gedanken über sowas macht, ist das auch übersichtlich machbar.
edit: aber wir schweifen hier gerade ziemlich hart ab. Mein Punkt nochmal in kurz: Verständliche und übersichtliche Events die am besten noch gut kommentiert sind, sind in erster Linie nützlich für den Entwickler, weil man dadurch gerade beim Debugging und wenn man nach längerer Pause wieder ins Spiel steigt um einiges leichter klarkommt. Wer was anderes sagt geht auch zur Domina.
Geändert von WeTa (24.05.2013 um 20:39 Uhr)
Berechtigungen
Zitieren
