Wikifunctions:Namenskonventionen

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

Bezeichnungen von Objekten sollten so geschrieben werden, als wären sie ein gewöhnlicher Satz. Von der Verwendung der Großschreibung wird abgeraten (z. B. Die Entfernung Zwischen Erde Und Sonne An Einem Bestimmten Datum Berechnen). Gib stattdessen etwas ein wie Entfernung zwischen Erde und Sonne an einem bestimmten Datum berechnen. Schreibe nur Eigennamen und andere Wörter groß, wie es die Grammatikregeln der gewünschten Sprache (z. B. Nomen auf Deutsch oder Wochentagsnamen auf Englisch) oder Konventionen erfordern (verwende im Englischen RSA und nicht rsa).

Gemäß der Konvention sollte bei Namen von Objekten, die Datentypen beschreiben, der Anfangsbuchstabe groß geschrieben werden (z. B. Object (Z1) oder Function (Z8)).

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, auch einen Algorithmusnamen in die Bezeichnung einzufügen (vorausgesetzt, der Algorithmus hat einen eigenen Namen).

Testfälle

Die Bezeichnung eines Testfalls sollte einen Hinweis darauf geben, was Sie dort überprüfen. Sie muss nicht den Wert jeder Eingabe 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-Argumentwert 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 enthält (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 true negated is false (Z10512) für ein Beispiel. Zum Zeitpunkt des Verfassens dieser Seite verwendet die Software diese Bezeichnungen jedoch nicht als Rückfalloption.