Wikifunctions:Namenskonventionen
 |  Diese Seite ist derzeit ein Entwurf. Mehr Informationen dazu kannst du evtl. auf der Diskussionsseite erhalten. Übersetzungsadministratoren: Normalerweise sollten Entwürfe nicht für eine Übersetzung markiert werden. |
Diese Seite soll einige Konventionen zur Benennung von Objekten in Wikifunctions zusammenfassen. Da das Projekt noch jung ist, sind noch nicht viele Leitlinien definiert.
Großschreibung
In einigen Sprachen werden Groß- und Kleinbuchstaben verwendet. Bezeichnungen von Objekten sollten in solchen Sprachen so geschrieben werden, als wären sie ein gewöhnlicher Satz. Von der Verwendung der Großschreibung wird abgeraten. Gib statt Die Entfernung Zwischen Erde Und Sonne An Einem Bestimmten Datum Berechnen etwas ein wie Entfernung zwischen Erde und Sonne an einem bestimmten Datum berechnen.
Schreibe nur Eigennamen und andere Wörter groß, wenn dies von den Regeln der Sprache, in der du schreibst, verlangt wird. Dies gilt beispielsweise für Nomen im Deutschen und für einige Wortklassen im Englischen, wie Wochentage und Sprachnamen. Schreibe diese Dinge nicht groß, wenn die Regeln deiner Sprache dies nicht verlangen. Abkürzungen sollten ihre konventionelle Form verwenden; verwende beispielsweise im Englischen "RSA" und nicht "rsa" für den Namen des Verschlüsselungsalgorithmus.
Gemäß der Konvention sollte bei Namen von Objekten, die Datentypen beschreiben, der Anfangsbuchstabe groß geschrieben werden (z. B. Z1 oder Z8).
Suchzeichen
Die Suchmaschine verwendet einige Zeichen als Modifikatoren, vermeide diese also am Anfang eines Wortes. Diese Zeichen sind: ~ * \? - " !.
Beachte, dass "?" allein (und nicht "\?") kein Modifikator ist. Es ist jedoch ein Zeichen im "Graubereich". Andere Zeichen im "Graubereich" sind ~ ! @ # $ % ^ & ( ) _ + - = { } | [ ] \ : " ; ' < > ? , . /. Die Suchmaschine behandelt diese (einzeln oder in Kombination) als Teil der Wortgrenze. Dies ist im Allgemeinen kein Problem, aber wenn sie bei der Suche wahrscheinlich eine Rolle spielen, solltest du sie am Anfang oder Ende eines Wortes (oder zwischen Wörtern) vermeiden, sofern sie nicht zwingend erforderlich sind (zum Beispiel Z11729). Siehe Hilfe:CirrusSearch für Details zur Suche nach Text, der eines dieser Zeichen enthält.
Namen von Implementierungen
Gib beim Erstellen einer Implementierung bitte die von dir verwendete Sprache im Namen an (Python/JavaScript/Komposition). Wenn es mehr als eine Implementierung in derselben Sprache gibt, wird empfohlen, im Titel einen Hinweis darauf zu geben, wodurch sich diese Implementierung unterscheidet. Gib beispielsweise den Namen des Algorithmus an (sofern vorhanden).
Testfälle
Bezeichnungen eines Testfalls sollten einen Hinweis darauf geben, was sie dort überprüfen. Sie muss nicht Werte für jede Eingabe und Ausgabe enthalten, sollte aber zumindest eine Domäne angeben, die du überprüfst. Beispielsweise möchtest du sagen, dass dieser Test das Verhalten einer Zeichenketten-Funktion prüft, wenn ihr Buchstaben aus dem kyrillischen Alphabet übergeben werden, oder einer mathematischen Funktion, wenn ein Bruch oder eine komplexe Zahl übergeben wird.
Wenn sich der Testfall auf eine Zeichenketten-Funktion bezieht und du einen Zeichenketten-Argument in den Testfallnamen aufnimmst, umgib diesen bitte mit Anführungszeichen oder kennzeichne ihn auf andere Weise, damit klar ist, welches der Wert ist. Dies ist besonders hilfreich, wenn der Wert am Anfang oder Ende relevante Leerzeichen hat (z. B. beim Testen einer Funktion zum Zuschneiden von Text).
Mehrsprachige Bezeichnungen
Bezeichnungen in mehreren Sprachen (unter Verwendung des Sprachcodes mul) können verwendet werden, um die Bezeichnung auf eine Weise anzugeben, die keine Wörter enthält, beispielsweise als mathematischer Ausdruck. Siehe Z10512 für ein Beispiel. Zum Zeitpunkt des Verfassens dieser Seite verwendet die Software diese Bezeichnungen jedoch nicht als Rückfalloption.