Hilfe:Leitfaden für Autoren
Aus Spieleprogrammierer-Wiki
(Unterschied zwischen Versionen)
| [gesichtete Version] | [gesichtete Version] |
K (→Artikel entwickeln auf einer Unterseite deiner Benutzerseite) |
(→Seitenspezifische Richtlinien) |
||
| Zeile 45: | Zeile 45: | ||
: Ein Wiki-Artikel wird normalerweise von vielen Autoren bearbeitet/geändert. Darum ist es nicht angemessen, in der ersten Person Singular ("ich") zu schreiben. Sätze wie "''Ich'' empfehle dir Visual C++ 2010." oder "''Ich'' hatte am Anfang auch zuerst Probleme, das zu verstehen." sind in einem Wiki-Artikel nicht erwünscht. "Wir" ist hingegen eher akzeptabel. | : Ein Wiki-Artikel wird normalerweise von vielen Autoren bearbeitet/geändert. Darum ist es nicht angemessen, in der ersten Person Singular ("ich") zu schreiben. Sätze wie "''Ich'' empfehle dir Visual C++ 2010." oder "''Ich'' hatte am Anfang auch zuerst Probleme, das zu verstehen." sind in einem Wiki-Artikel nicht erwünscht. "Wir" ist hingegen eher akzeptabel. | ||
| − | == Seitenspezifische Richtlinien == | + | ៛== Seitenspezifische Richtlinien == |
Darüber hinaus solltest du folgende Hinweise beherzigen, die vor allem für Artikel in unserem Wiki wichtig sind: | Darüber hinaus solltest du folgende Hinweise beherzigen, die vor allem für Artikel in unserem Wiki wichtig sind: | ||
| + | |||
| + | ;Stelle den Code nicht in den Mittelpunkt deines Artikels! | ||
| + | : Versuche die ''Idee'' von Dingen zu beschreiben. Programmiersprachen und Bibliotheken ändern sich mit der Zeit. Eine Idee ist unabhängig von Code und bleibt daher viel länger gültig bzw. nachvollziehbar. Ein Artikel sollte zunächst immer die Funktionsweise von Dingen beschreiben, und zwar möglichst unabhängig von konkretem Code. Wenn das gut umgesetzt ist, kann der Leser das Beschriebene selber programmieren. Natürlich kann bei Bedarf eine Beispielimplementierung oder eine Liste von Tipps zur Implementierung folgen. Auf dem Code sollte aber nicht der Hauptfokus eines Artikels liegen (hier gibt es natürlich Ausnahmen bei extrem technischen Artikeln). | ||
| + | |||
| + | ;Versuche Konzepte unabhängig von der Programmiersprache zu erklären! | ||
| + | : Damit möglichst viele Leser deinem Artikel folgen können, solltest du versuchen, Konzepte möglichst unabhängig von einer bestimmten Programmiersprache zu erklären. Benutze ggf. [http://de.wikipedia.org/wiki/Pseudocode Pseudocode], um Algorithmen zu beschreiben. | ||
;Sprich den Leser mit "du" an! | ;Sprich den Leser mit "du" an! | ||
| Zeile 54: | Zeile 60: | ||
;Folge einem guten Programmierstil! | ;Folge einem guten Programmierstil! | ||
: Wenn dein Artikel Beispiel-Code enthält, gib dir Mühe, deinen Code gut lesbar zu gestalten und ihn mit ausreichend vielen Kommentaren zu versehen. Verwende einheitliche Formatierung und Einrückung. Benenne Klassen, Schnittstellen, Variablen und Methoden nach einem einheitlichen und sinnvollen Schema. Vermische bitte nicht deutsche und englische Bezeichner im Code! Versuche, deinen Code standardkonform zu halten, damit er auf möglichst vielen Plattformen funktioniert. Wir möchten dir nicht vorschreiben, welchem Stil du folgen sollst, aber sei ''konsistent''. | : Wenn dein Artikel Beispiel-Code enthält, gib dir Mühe, deinen Code gut lesbar zu gestalten und ihn mit ausreichend vielen Kommentaren zu versehen. Verwende einheitliche Formatierung und Einrückung. Benenne Klassen, Schnittstellen, Variablen und Methoden nach einem einheitlichen und sinnvollen Schema. Vermische bitte nicht deutsche und englische Bezeichner im Code! Versuche, deinen Code standardkonform zu halten, damit er auf möglichst vielen Plattformen funktioniert. Wir möchten dir nicht vorschreiben, welchem Stil du folgen sollst, aber sei ''konsistent''. | ||
| − | |||
| − | |||
| − | |||
;Formatiere Code-Blöcke und Code-Elemente im Fließtext! | ;Formatiere Code-Blöcke und Code-Elemente im Fließtext! | ||
Version vom 17. November 2011, 20:31 Uhr
Klicke hier, um diese Version anzusehen.
