NET/תיעוד
< NET
| תכנות בסביבת NET |
|---|
|
תיעוד קוד עוזר למתכנתים אחרים להבין את הקוד. בתיעוד צריך לכתוב תקציר על הפונקציה/מחלקה/מרחב שמות ואפשר לכתוב הסבר על הפרמטרים של הפונקציה ומה היא מחזירה.
התיעוד קוד מוסיף הסבר על הפונקציות בסביבה עצמה, בנוסף לכך אפשר גם לייצא קבצי xml של הקוד בתבנית של קבצי העזרה של MSDN.
התיעוד נכתב כך: ב-VB .NET:
''' <summary>
''' תקציר
''' </summary>
וב-CSharp:
/// <summary>
/// תקציר
/// </summary>
קישורים
עריכההסבר מפורט על אופן השימוש בתגיות: MSDN