כיצד עושים תיעוד (vb.net)

  • פותח הנושא q8z
  • פורסם בתאריך

q8z

New member
כיצד עושים תיעוד (vb.net)

'like this? 'how can i add a good documentation ? 'do loop to put the items from the data set Sub fill() Me.ArrayTextBox(2, 9) = New System.Windows.Forms.TextBox() Dim i As Integer Dim j As Integer Dim k As Integer k = 31 For i = 0 To 1 For j = 0 To 9 ArrayLabel(i, j) = New System.Windows.Forms.Label() ArrayLabel(i, j).Cursor = System.Windows.Forms.Cursors.Hand ArrayLabel(i, j).Size = New System.Drawing.Size(30, 30) ArrayLabel(i, j).Location = New System.Drawing.Point(i * 60 + 30, j * 30) ArrayLabel(i, j).Enabled = True ArrayLabel(i, j).Text = "l" ArrayLabel(i, j).TabIndex = k ArrayLabel(i, j).Name = String.Format("L+{0}", k) Controls.AddRange(New System.Windows.Forms.Control() {Me.ArrayLabel(i, j)}) k = k + 1 Next Next k = 1 For i = 0 To 2 For j = 0 To 9 Me.ArrayTextBox(i, j) = New System.Windows.Forms.TextBox() Me.ArrayTextBox(i, j).Cursor = System.Windows.Forms.Cursors.Hand Me.ArrayTextBox(i, j).Size = New System.Drawing.Size(30, 30) Me.ArrayTextBox(i, j).Location = New System.Drawing.Point(i * 60, j * 30) ArrayTextBox(i, j).Enabled = True ArrayTextBox(i, j).Text = "" ArrayTextBox(i, j).TabIndex = k ArrayTextBox(i, j).Name = String.Format("TB+{0}", k) Me.Controls.AddRange(New System.Windows.Forms.Control() {Me.ArrayTextBox(i, j)}) k = k + 1 Next Next Dim dt2 As Data.DataTable dt2 = Me.ds.Tables(0) For j = 0 To 2 For i = 0 To 9 Me.ArrayLabel(0, i).Text = Me.ds.Tables(0).Rows(i)(1).ToString() Me.ArrayLabel(1, i).Text = "=" If j = 0 Then Me.ArrayTextBox(1, i).Text = seti(i, 3) Me.ArrayTextBox(2, i).Text = seti(i, 4) End If If j = 1 Then Me.ArrayTextBox(0, i).Text = seti(i, 2) Me.ArrayTextBox(2, i).Text = seti(i, 4) End If If j = 2 Then Me.ArrayTextBox(0, i).Text = seti(i, 2) Me.ArrayTextBox(1, i).Text = seti(i, 3) End If Next Next End Sub​
 
2 הכללים הבסיסיים לתיעוד נכון

1) לא לכתוב דברים מובנים מאליהם:
//Writes Hello Console.WriteLine("Hello");​
2) לא לכתוב דברים סתומים:
//TODO: Change this later GetConnection(IPAddress);​
בדוגמה הזו לא כתוב מה צריך לשנות, איך ולמה. בעיקרון, לפני כל CLASS וכל פונקציה צריך להיות תיעוד של: שם הפונקציה, פרמטרים, ערך מוחזר ומה היא עושה. כמו כן, לפני כל שורה שצריכה הבהרות לגבי אופן הפעולה שלה צריך להיות תיעוד.
 
למעלה