[Diskussion] Code-Standards im Plugins- und Mods-Forum

[Cabraca]

Hallo,
da die Codequalität in besagtem Forum immer mehr Richtung "wer schreibt so nen scheiß" geht würde ich gern
eine Richtlinie erstellen, die neue Plugins erfüllen müssen um freigeschaltet zu werden.
Da ich vermutlich eh zu hohe Maßstäbe setze würde ich gern mal von euch wissen was ihr da drin haben wollt.

Momentan ist folgendes angedacht:

Keine OP- oder andere Hacks
Sinnvolle Aufteilung in Klassen
Sinnvolle Variablennamen
Es wird für Thread safety gesorgt wenn mit Threads gearbeitet wird.
Sollte das Plugins irgendwelche Libraries (z.B. PluginMetrics) nutzen muss dies im Thread angegeben werden
Angabe der Lizenz unter welcher das Plugin veröffentlicht wird.
Zum Freischalten muss der Sourcecode dem freischaltenden Moderator zugänglich sein (bzgl *.exe und obfuskierten *.jar Dateien).
Code folgt dem DRY-Prinzip (by igneel)
Bei Bukkit Plugins: Ausgaben in die Konsole müssen über den Bukkit Logger gemacht werden (by Benni1000)

Wer noch weitere punkte hat bitte hier eintragen.

MFG Cab

 

[TimBone]

Ich glaube, so etwas war schon einmal geplant. Das Problem wird nur sein, dass es irgendwann für die Moderatoren nervig wird einen 'riesigen' Quellcode zu überprüfen. Trotzdem befürworte ich diese Idee, da ich hier dann auch mal ein Plugin runterladen würde

 

[|| xX [DEV][LP] Ms. DivaCraft Xx ||]

Es sollte sich etwas an die Woltlab Pluginstore Richtlinien orientieren (Mir ist aber klar, dass Java != php)
[http://www.woltlab.com/de/pluginstore/faq.html#section-102]

Das würde dazu führen:

• Sun-Java Kompatibel.
• Lizenz von Libraries angeben.
• Wenn open-source mit Github oder vergleichbarer Möglichkeit.
• Wenn MySQL vorhanden ist mit Cache und MySQL-Injektion Schutz.

 

[games6471]

Wieso kommt dies nicht in Selbstgeschriebenes?

Dieses Thema gilt so wie ich das sehe nur für den gennanten Bereich oder irre ich mich hier?

(Wie "Sonderregelung für dieses Forum" sollte dieses ebenfalls dort auch als wichtig markiert werden)

 

[|| xX [DEV][LP] Ms. DivaCraft Xx ||]

@games6471 Weil dies eine Diskussion ist, deswegen.

 

[Cabraca]

Dies soll eine Diskussion der im Forum beteiligten Programmierer sein.
Natürlich wird die Richtline später im entsprechenden Forum angepinnt.
Wie der Titel aber schon sagt ist dies hier nur eine Diskussion.

 

[Smuil]

schleifen verwenden und kein tausendfaches copy & paste?

 

[Cabraca]

hab ich mal hinzugefügt iggi.

 

[Crafter213]

Wie wärs denn dann mit Codebeispielen?
Es wäre toll, wenn man als Anfänger Plugincode vorstellen kann und dann Verbesserungsvorschläge bekommt.
Das ist, denke ich, die beste Möglichkeit, wie hinterher auch guter Code rauskommt, da die Programmierer dann lernen,
wie es gut funktioniert und nicht, wie es irgendwie funktioniert

 

[Cabraca]

könnte man ja ggf noch ein unterforum "Plugins/Mods in arbeit" oder so eröffnen.

 

[Benni1000]

Ich finde die Idee sehr gut, und einen Vorschlag habe ich auch:

• Ausgaben in die Konsole müssen über den Bukkit Logger gemacht werden.

 

[games6471]

Mir ist auch eine Idee eingefallen:

• Debug-Code sollte bei Release entfernt oder gegebenfalls ausstellbar sein.

 

[Cabraca]

Bis Freitag 22 Uhr ist noch Zeit hier Vorschläge einzubringen.
Danach gehen die Regeln live!

 

[games6471]

Könnte man nicht danach immer noch etwas hinzugefügen ?

 

[Cabraca]

erstmal die grundfassung fest verankern

 

[Crafter6432]

Wenn MySQL vorhanden ist mit Cache ...

Besser wäre aber alles IO in einen Thread Ausnahme, in der onEnable Methode.

 

[LBuilder]

Finde die Vorschläge gut. Ein + von mir.
Um die Code/das Unterforum sauber zu halten sollten die Sektion-Mods die Plugins bei zu "versauten" Codes erst garnicht freischalten. Somit sind nahezu "saubere" Plugins garantiert.

Liebe Grüße,
LBuilder.