Wikifunkcje:Konwencje nazewnicze
 |  Ta strona jest jedynie szkicem. Więcej informacji z nią związanych może znajdować się na stronie dyskusji. Do administratorów tłumaczeń: szkiców zazwyczaj nie należy oznaczać do tłumaczenia. |
Strona ma na celu podsumowanie niektórych konwencji związanych z nazwami obiektów na Wikifunkcjach. Ponieważ jest to wciąż młody projekt, nie ma jeszcze określonych wielu wytycznych.
Kapitalizacja
Etykiety obiektów należy pisać tak, jakby były zwykłą frazą. Nie zaleca się używania Wielkich Liter w tytule (np. „Oblicz Odległość Między Ziemią A Słońcem W Podanym Dniu”). Zamiast tego wpisz coś w rodzaju „oblicz odległość między Ziemią a Słońcem w podanym dniu”. Używaj wielkich liter tylko dla rzeczowników własnych i innych wyrazów, jeśli wymagają tego reguły gramatyki danego języka (np. rzeczowniki w języku niemieckim lub nazwy własne, jak dni tygodnia w języku angielskim) lub konwencje (w języku angielskim używaj „RSA”, a nie „rsa”).
Zgodnie z konwencją, nazwy obiektów opisujących typy danych powinny mieć pierwszą literę pisaną wielką literą (np. Object (Z1) czy Function (Z8)).
Search characters
The search function uses a few characters as modifiers, so avoid these at the start of a word. These characters are: ~ * \? - " !. Note that “?” on its own (rather than “\?”) is not a modifier. It is, however, a “greyspace” character. Other “greyspace” characters are ~ ! @ # $ % ^ & ( ) _ + - = { } | [ ] \ : " ; ' < > ? , . /. Search treats these (singly or in combination) as part of the word boundary. This is not generally a problem but if they are likely to be significant in searches, you should avoid them at the start or end of a word (or between words). See Help:CirrusSearch for details of how to search for text containing any of these characters.
Nazwy implementacji
Tworząc implementacje, uwzględnij w ich nazwach zastosowany język programowania (Python/JavaScript/Złożenie). Jeśli istnieje wiele implementacji w danym języku, warto również określić w etykiecie, co odróżnia je od pozostałych, np. z jakiego algorytmu skorzystano (o ile ma on swoją nazwę).
Przypadki testowe
Etykiety przypadków testowych powinny wskazywać na to, co on sprawdza. Nie trzeba koniecznie podawać wartości każdego argumentu i oczekiwanego wyjścia, ale należy wskazać choćby dziedzinę, poddaną sprawdzeniu. Na przykład możesz wskazać, że dany przypadek sprawdza zachowanie funkcji tekstowej, gdy dostanie litery z cyrylicy. Albo funkcji matematycznej, kiedy przekaże się jej ułamek czy liczbę zespoloną.
Jeśli przypadek testowy dotyczy funkcji tekstowej i umieszczasz wartość argumentu w nazwie przypadku, otocz tę wartość cudzysłowami lub w inny sposób określ, że to jest wartość. Pomaga to szczególnie, gdy ten ciąg zawiera znaczące białe znaki na początku lub na końcu (np. przy testowaniu funkcji ucinającej je).
Etykiety wielojęzykowe
Etykiety w wielu językach (korzystające z kodu języka mul) mogą być stosowane do określenia etykiety niewykorzystującej słów, np. wyrażenia matematycznego. Zobacz na przykład true negated is false (Z10512). W chwili pisania, oprogramowanie nie korzysta jednak z tego typu etykiet w przypadku gdy nie jest dostępna etykieta w Twoim języku.