Komentarze w kodzie (Visual Basic)
Podczas czytania przykłady kodu, często napotykają symbol komentarz (').Ten symbol informuje o tym, Visual Basic kompilatorowi ignorowanie tekstu, następujące po niej, lub komentarz.Komentarze są krótkie uwagi wyjaśniające, dodane do kodu z korzyścią go czytać.
Jest dobry, Programowanie praktyki do wszystkich procedur zaczynają się krótki komentarz opisujący charakterystyka funkcjonalna procedury (czego).Jest to dla własnych korzyści i z korzyścią dla wszystkich osób, które sprawdza, czy kod.Szczegóły dotyczące implementacji (jak procedura robi) należy oddzielić od komentarzy, które opisują cechy funkcjonalne.Po dołączeniu szczegóły implementacji w opisie, pamiętaj, aby zaktualizować je podczas aktualizacji funkcji.
Komentarze można postępuj według instrukcji w tym samym wierszu lub zajmują cały wiersz.Obie są przedstawione w poniższym kodzie.
' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!" ' This is an inline comment.
Jeśli Twój komentarz wymaga więcej niż jednego wiersza, należy użyć symbolu komentarz w każdym wierszu, jak ilustruje poniższy przykład.
' This comment is too long to fit on a single line, so we break
' it into two lines. Some comments might need three or more lines.
Wytyczne komentowania
Poniższa tabela zawiera ogólne wytyczne dla jakich typów komentarze można poprzedzać sekcji kodu.Są one sugestie; Visual BasicWymusza zasady dodawania komentarzy.Napisać, co sprawdza się najlepiej, zarówno dla Ciebie i innych osób, który odczytuje kodu.
Typ komentarza |
Opis komentarza |
Cel |
W tym artykule opisano, co robi procedury (nie jak to robi) |
Założenia |
Wyświetla listę zewnętrznych każdej zmiennej, kontroli, otwartego pliku lub innego elementu dostęp według procedury |
Efekty |
Każdy list dotyczy zmiennej zewnętrznych, kontroli, lub plik i efekt, który ma (tylko wtedy, gdy nie jest oczywiste) |
Dane wejściowe |
Określa cel argument |
Zwraca |
Wyjaśnia wartości zwróconej przez procedurę |
Należy pamiętać o następujących punktów:
Co ważne deklaracja zmiennej powinien być poprzedzony komentarz opisujący użycie zmiennej, zostały zgłoszone.
Zmienne, kontroli i procedur powinien zostać nazwany wystarczająco jasno że komentowania, konieczne jest jedynie dla wdrażania złożonych szczegóły.
Komentarzy nie może następować sekwencji kontynuacji wiersza w tym samym wierszu.
Można dodać lub usunąć komentarz symbole dla bloku kodu, zaznaczając jeden lub więcej wierszy kodu i wybierając komentarz (.gif "Obiekt VisualBasicWinAppCodeEditorCommentButton")
) i Odkomentuj (.gif "Obiekt VisualStudioWinAppProjectUncommentButton")
) przycisków dostępnych na Edytuj paska narzędzi.
[!UWAGA]
Można również dodawać komentarze do kodu, poprzedzając tekst z REM słowa kluczowego.Jednakże ' symbol i komentarz/Odkomentuj przyciski są łatwiejsze w użyciu i wymagają mniej miejsca i pamięci.