Korrekt Kommentieren in Scripts

Man fragt sich vielleicht manchmal, wo und wie man am besten kommentiert, in diesem Kurztutorial wirst du auf diese Fragen Antworten erhalten.

Was sind Kommentare in Skripts?
Kommentare sind Kleine Sätze, die die z.B die Bedeutung eines Skriptteiles hervorheben.

Wofür sind Kommentare gut?
Gerade für Neulinge des Skriptens sind sie hilfreich, z.B wenn sie wissen wollen, was eine bestimmte Funktion in einem Skript macht.

Wie macht man Kommentare?
Es gibt zwei Möglichkeiten dies zu tun. Folgende sind möglich:
// und /**/

Worauf sollte man achten, wenn man Skriptteile kommentiert?
-Seltene oder ziemlich komplizierte Scriptteile per Kommentar erkenntlich machen
-Bekannte Fehler des Skriptes können mit "///////" kommentiert werden, damit man ihn später wiederfindet, wenn man ihn beheben möchte.
-Kommentare sollten so aktuell wie möglich sein. d.h. sie sollten nach Skriptänderung aktuallisiert werden.
-"/**/" sollte für längere Sätze benutzt werden, wenn man etwas genauer erklärt.
-Ein /**/ sollte am Anfang des Skriptes stehen, und darin sollte entweder die Hauptfunktion, oder der Name des Objektes/Szenarios enthalten sein.

Was ist in einem Kommentar tabu?
-Smileys(Es gibt einige Ausnahmen, es sollte jedoch nicht übertrieben werden)
-"^^", "lol",u.s.w...
-Sinnlose Kommentare vermeiden, z.B "Ja11 und dann mact der flynt bumm."
-Heiratsanträge

Beispiele für gutes Kommentieren?
Ich nehme hier den Skript des Flints, da er klein ist. Einen Flint wie diesen sollte man in der Regel nicht Kommentieren.

Zitat :

/*--- Flint ---*/

#strict

public func ExplodeSize()
{
return(16); //Explodiert mit der Grösse 16
}

protected func Hit()
{
Explode(ExplodeSize());
}

/* Kann in der Chemiefabrik hergestellt werden */
public func IsChemicalProduct() { return(1); }

func IsAlchemContainer() { return(true); }
func AlchemProcessTime() { return(100); }

Gut, aber kannst du den Smiley nicht irgendwie wegmachen? Der entsteht immer wenn "8" und ")" macht. Nimm einfach Explode(16).

Extremclonk:
Done. Ich hatte mir schon überlegt, wie ich den Smiley umgehen könnte.

Man kann auch einfach die Smileys im Beitrag deaktivieren

8)