תיעוד קוד בJavaScript
-
@צדיק-תמים אמר בעזרה - ביטול פיצול שורות מציק בPrettier:
ואשמח לדעת איך אפשר לכתוב תיאור ככה שיראו אותו גם בריחוף על שם הפונקציה
https://www.google.com/search?q=JSDOC תוצאה ראשונה:
https://jsdoc.app/ -
-
@WWW החסכנות שלך בהסברים משונה.
הבאת תוצאה ראשונה בגוגל למונח JSDOC שלא היה ידוע לשואל.@צדיק-תמים זה מוסכמה, הכלי הוא לייצא את התיעוד אם אני לא טועה.
תראה את הקוד הבא בVSCODE
הVSCODE תומך בזה יפה מאוד, אתה קודם כותב את הפונקציה, אח"כ הולך מעליה וכותב סלש ושני כוכביות וטאב, והופה אתה מקבל שלד מוכן.
-
-
@צדיק-תמים אמר בתיעוד קוד בJavaScript:
יש אופציה מהפופ-אפ שקופץ בריחוף, גם לקפוץ להגדרת הפונקציה?
לא מהpopup אבל אפשר עם F12 על שם הפונקציה.
-
@dovid אמר בתיעוד קוד בJavaScript:
@WWW החסכנות שלך בהסברים משונה.
הבאת תוצאה ראשונה בגוגל למונח JSDOC שלא היה ידוע לשואל.בתחילה שמתי רק את הקישור השני, לאחמ"כ נמלכתי וערכתי ושמתי גם את החיפוש, בדיוק בשביל זה שיידע איך קוראים לזה, ויידע לחפש ע"ז עוד מידע, ורק דרך אגב, כתבתי שהקישור זה התוצאה הראשונה, כי לא היה לי זמן לבדוק ב100% שזה טוב בשבילו (ראיתי שם דוגמאות של DOC, אבל כפי ש @צדיק-תמים כתב זה באמת לא ממש הסבר).
אני לוקח את הערתך לתשומת לב, השאלה אם עדיף בכזה מקרה שאין עיתותי בידי, לא להגיב בכלל?
ו... חבל שאתה כותב בצורה כוללנית, כי אני כן משתדל בד"כ לנסח כמה שיותר, על אף שאני לא סופר. -
@www ראשית כל קבל את התנצלותי, אני ממש מעריך את העזרה ככל שתהיה שאתה נותן ואתה בהחלט נותן וגם אני נהניתי ממנה כבר כמה פעמים.
אבל אני אוהב להיות אמיתי וישיר, ואני אכן עומד על מילותיי והם לא חדשות לך לגמרי.
זה לא עניין של זמן (גם אני לאחרונה כותב לעיתים הודעות קצרות מאוד מחוסר זמן), זה יותר עניין של גישה.
אם אתה רוצה באמת לבדוק את זה, בפעם הבאה שאתה עונה למישהו ואפילו כשאתה שואל, תאמץ בדמיונך כאילו אתה סוכן מכירות שמנסה למכור לשני את הידיעה/שאלה באופן שהוא "ישתה" אותה.
שים לב, הניסוי צריך להבצע באותם מגבלות של זמן ואפילו אולי באותה כמות מילים... עדיין יהיה פער ענק בין ה"מזמינות" של הטקסט.
זו דוגמה קיצונית, אבל זה יחדד לך את הפער בין הכיוון ההפוך.
תגיד שאף אחד לא משלם לך פה על ההודעות? זה כי לא ביקשת
