Wikifunctions:Naming conventions
![]() |
כעת, דף זה הוא טיוטה. מידע נוסף עשוי להימצא ב־דף השיחה. מנהלי תרגום: בדרך כלל, אין לסמן טיוטות לתרגום. |
הדף הזה נועד לסכם כמה דרכים מקובלות לכינוי עצמים בוויקיפונקציות. מכיוון שזה עדיין מיזם צעיר, עדיין לא הוגדרו הרבה קווים מנחים.
אותיות רישיות וקטנות
חלק מהשפות משתמשות באותיות רישיות וקטנות. תוויות של עצמים צריכות להיות כתובות בשפות כאלו כאילו היו ביטוי רגיל. השימוש ב־Title case, כפי שנהוג באנגלית, אינו מומלץ. למשל, במקום לכתוב באנגלית Calculate A Distance Between Earth And Sun On a Given Date יש לכתוב משהו כמו calculate a distance between Earth and Sun on a given date.
יש להשתמש באותיות רישיות רק בשמות פרטיים ובמילים אחרות בהתאם לכללי השפה שלך. משל, זה חל על שמות עצם בגרמנית, ועל כמה מחלקות של מילים באנגלית, כגון ימי השבוע ושמות של שפות. אין צורך לכתוב את הדברים האלה באותיות גדולות אם כללי השפה שלך לא דורשים את זה. קיצורים צריכים להשתמש בצורתם המקובלת; למשל, באנגלית, יש להשתמש ב־"RSA" ולא ב־"rsa" עבור שם אלגוריתם ההצפנה.
מקובל ששמות של עצמים שמתארים סוגי נתונים יהיו כתובים באות ראשונה גדולה (למשל Object (Z1) ו־Function (Z8)).
תווי חיפוש
מנוע החיפוש משתמש בכמה תווים שמשנים את משמעות השאילתה, אז יש להימנע מכתוב אותם בתחילת מילה. התווים האלה הם: ~ * \? - " !
.
נא לשים לב לכך שהתו "?" בפני עצמו (ולא "\?") אינו משנה את השאילתה. עם זאת, מדובר בתו מסוג "greyspace". תווי "greyspace" אחרים הם ~ ! @ # $ % ^ & ( ) _ + - = { } | [ ] \ : " ; ' < > ? , . /
. מנוע החיפוש מתייחס אליהם (לחוד או בשילוב) כחלק מגבול המילה. בדרך־כלל זאת לא בעיה, אבל אם הם צפויים להיות משמעותיים בחיפושים, כדאי להימנע מהם בתחילת המילה או בסופה (או בין מילים), אלא אם יש צורך (למשל: German noun, -s declension (Z11729)). ר' עזרה:CirrusSearch לפרטים על חיפוש טקסט שמכיל כל אחד מהתווים האלה.
שמות המימושים
בעת יצירת מימוש, יש לציין את השפה שהשתמשת בה בשמה (פייתון / JavaScript / הרכבה). אם יש יותר ממימוש אחד באותה שפה, מומלץ לפרט מעט בכותרת מה הופך את המימוש הזה לשונה. למשל, להזכיר את שם האלגוריתם (אם קיים).
מקרי בדיקה
תוויות של מקרי בדיקה צריכות לספק רמז כלשהו לגבי מה שהן בודקות. זה לא חייב לכלול ערכים עבור כל קלט ופלט, אבל כן צריך לציין לפחות תחום שנבדק. למשל, אולי תרצה לומר שהבדיקה הזאת בודקת את ההתנהגות של פונקציית מחרוזת כאשר ניתנות לה אותיות מהאלפבית הקירילי, או של פונקציה מתמטית כאשר מעבירים אליה שבר או מספר מרוכב.
אם מקרה הבדיקה קשור לפונקציית מחרוזת, וכללת ארגומנט מחרוזת בשם מקרה הבדיקה, נא להקיף את הארגומנט במירכאות או לסמן אותו בדרך אחרת כדי שיהיה ברור מה הערך. זה מועיל במיוחד אם לערך יש רווח לבן משמעותי בהתחלה או בסוף (למשל, בעת בדיקת פונקציית חיתוך טקסט).
תוויות רב־לשוניות
ניתן להשתמש בתוויות בשפות מרובות (באמצעות קוד השפה mul
) כדי לציין את התווית באופן שאינו כולל מילים, למשל כביטוי מתמטי. ר' true negated is false (Z10512) למשל. עם זאת, ברגע כתיבת השורות האלו, התוכנה אינה משתמשת בתוויות האלו בתור שפת גיבוי.