רוטר - תוכניתנים- אתם כותבים הערות בקוד?

יומן פעילות	לוח שנה	מבזקי חדשות	תקנון	RSS	כותרות	כותרות לפי תגובה	ניקוי קוקיז	IP	להורדת אפליקציה
eBay	AliExpress	GearBest	Amazon	Booking	Kiwi	SkyScanner	Trip Advisor

"תוכניתנים- אתם כותבים הערות בקוד?"

גירסת הדפסה

קבוצות דיון פיתוח, תיכנות ובניית אתרים נושא #20702	מנהל סגן המנהל מפקח Winner צל"ש מומחה

אשכול מספר 20702

כמה עוד

חבר מתאריך 18.11.09
234 הודעות, 11 פידבק

13:02 23.05.14

תוכניתנים- אתם כותבים הערות בקוד?

הועבר בתאריך 23.05.14 בשעה 14:24 מפורום שיחות חברים על-ידי SoMe1, (מנהל הפורום)

מעניין אותי כמה אנשים באמת מקפידים על זה או לחילופין חושבים שזה מיותר

מנהלים בבקשה תשאירו בשיח ולא להעביר לפורום תיכנות..

שתף

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

האשכול	מחבר	תאריך כתיבה	מספר
פורום תיכנות	swat-team	23.05.14 13:04	1
נדיר, חייב לעבוד לשנות את ההרגל הזה...	-UC-	23.05.14 13:15	2
אם לא הם כנראה לא רציניים..	LeeCooper	23.05.14 13:24	3
ברור.. אחרת זה נורא	Sylver	23.05.14 13:40	4
ברור, קרה לי מספר פעמים שחזרתי על פרוייקט שעבדתי ולא הבנתי מה הקטע קוד אומר	Dimona	23.05.14 13:42	5
חח מה זאת השאלה הזאת ? ברור שחייב, משעמם לך לחזור על קטעי קוד כל פעם מחדש ?	Ice Man	23.05.14 14:12	6
כמה שפחות	DOWNTOWN	23.05.14 15:37	7
טעות גדולה לדעתי, הערות בקוד לא חייבות להיות סדרת ספרים אבל אפילו שתי שורות עוזר	afroman50	23.05.14 15:42	8
לפעמים	DOWNTOWN	23.05.14 15:47	9
לדעתי זה מיותר ב 95 אחוז מהמקרים..	VeNom	23.05.14 17:06	10
ברור והכי טוב שיהיו ענייניות	King_Cobra	23.05.14 17:23	11
כמה שיותר וכמה שיותר ממוקד	meni181818	23.05.14 17:37	12
רק אם עושים משהו חריג/קומבינה	inno3D	23.05.14 19:11	13
זה מיותר, כמו שאמרו ב13... עדיף דוקומנטציה נפרדת בכל אופן...	Dotan	23.05.14 19:46	14
נדיר מאוד	bronho	23.05.14 20:30	15
עם הזמן	ליל קיץ	24.05.14 00:07	16
בהחלט, אבל לדברים מורכבים. בלי קשר שתמיד יש מסמכיאדה חיצונית	ldan192	24.05.14 11:52	17
תמיד זה חובה,	The Boss	24.05.14 12:33	18
כמובן...	Nesher	25.05.14 01:09	19

swat-team
חבר מתאריך 24.3.02
11797 הודעות, 2 פידבק

13:04 23.05.14

1. פורום תיכנות
בתגובה להודעה מספר 0

עו"ד, משפט אזרחי
ומסחרי, לשון הרע, וחוזים.

(ניהול: מחק תגובה)

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

-UC-

חבר מתאריך 1.8.02
21922 הודעות, 1 פידבק

13:15 23.05.14

2. נדיר, חייב לעבוד לשנות את ההרגל הזה...
בתגובה להודעה מספר 0

(ניהול: מחק תגובה)

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

LeeCooper

חבר מתאריך 14.7.05
2363 הודעות, 1 פידבק

13:24 23.05.14

3. אם לא הם כנראה לא רציניים..
בתגובה להודעה מספר 0

EMPTY

(ניהול: מחק תגובה)

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

Sylver
חבר מתאריך 1.7.02
11915 הודעות, 2 פידבק

13:40 23.05.14

4. ברור.. אחרת זה נורא
בתגובה להודעה מספר 0

(ניהול: מחק תגובה)

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

Dimona

חבר מתאריך 28.11.10
1910 הודעות, 1 פידבק

13:42 23.05.14

5. ברור, קרה לי מספר פעמים שחזרתי על פרוייקט שעבדתי ולא הבנתי מה הקטע קוד אומר
בתגובה להודעה מספר 0

(ניהול: מחק תגובה)

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

Ice Man
חבר מתאריך 24.3.02
23365 הודעות

14:12 23.05.14

6. חח מה זאת השאלה הזאת ? ברור שחייב, משעמם לך לחזור על קטעי קוד כל פעם מחדש ?
בתגובה להודעה מספר 0

(ניהול: מחק תגובה)

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

DOWNTOWN
חבר מתאריך 28.5.02
5388 הודעות

15:37 23.05.14

7. כמה שפחות
בתגובה להודעה מספר 0

נדיר שהקוד צריך הערות, בדר"כ אם צריך הערות בקוד, עדיף לכתוב אותו מחדש בצורה ברורה יותר.

(ניהול: מחק תגובה)

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

afroman50
חבר מתאריך 16.8.04
12555 הודעות, 1 פידבק

15:42 23.05.14

8. טעות גדולה לדעתי, הערות בקוד לא חייבות להיות סדרת ספרים אבל אפילו שתי שורות עוזר
בתגובה להודעה מספר 7

(ניהול: מחק תגובה)

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

DOWNTOWN
חבר מתאריך 28.5.02
5388 הודעות

15:47 23.05.14

9. לפעמים
בתגובה להודעה מספר 8

בכל מקרה לאורך של ההערות אין משמעות אבסולוטית, כל מקרה לגופו, לעיתים צריך הערה של שורה, לפעמים צריך 50 שורות שיסבירו *למה* הקוד עושה את מה שהוא עושה, עם איזה באגים בתשתית עליו הוא עובד הוא צריך להתמודד, או איזה הנחות הוא לא יכול להניח.

בכל מקרה, הערות צריכות תמיד להגיד רק *למה* ולא *איך*, כי על האיך עונה הקוד.
וגם לגבי ה"למה", בדרך כלל הדברים מספיק ברורים, ואם לא, צריך להוציא לפונקציה או מחלקה עם שם שמסביר את הבעיה, או לשנות את העיצוב של המערכת ככה שה"למה" יהיה ברור.

ברור שלפעמים צריך הערות, אבל כמעט תמיד מדובר בsmell שמצביע על בעיה כלשהיא (חוץ מreferenceים אם מדובר במימוש אלגוריתם או משהו דומה), בין אם במערכת או מחוצה לה.

(ניהול: מחק תגובה)

מכתב זה והנלווה אליו, על אחריות ועל דעת הכותב בלבד

VeNom

חבר מתאריך 7.6.02
7922 הודעות, 1 פידבק

17:06 23.05.14

10. לדעתי זה מיותר ב 95 אחוז מהמקרים..
בתגובה להודעה מספר 0

יש תמיד את התיעודים המוגזמים שמרוב שהם ארוכים אין לך כח לקרוא.
אם אתה כותב קוד טוב ו"שגרתי" אין מה לתעד אותו.

אם אתה עושה קומבינה או משהו חריג(כמו למספר enum בחזקות של 2 ולעשות עליו Bitwise operations אז שווה לך לרשום שורה, שהבא שיוסיף ערך ישים לב לכך - זו סתם דוגמא למקום שהייתי מתעד).