Udostępnij za pośrednictwem

Komentarze w kodzie (Visual Basic)

Podczas odczytywania przykładów kodu często występuje symbol komentarza ('). Ten symbol nakazuje kompilatorowi języka Visual Basic zignorowanie tekstu lub komentarza. Komentarze są krótkimi uwagami objaśniającymi dodanymi do kodu z korzyścią dla tych, którzy go odczytują.

Dobrym rozwiązaniem programistycznym jest rozpoczęcie wszystkich procedur z krótkim komentarzem opisującym cechy funkcjonalne procedury (co robi). Jest to dla Twojej własnej korzyści i korzyści dla każdego innego, kto analizuje kod. Szczegóły implementacji (jak to robi) należy oddzielić od komentarzy opisujących cechy funkcjonalne. W przypadku uwzględnienia szczegółów implementacji w opisie pamiętaj, aby zaktualizować je podczas aktualizowania funkcji.

Komentarze mogą podążać za wyrażeniem w tym samym wierszu lub zajmować cały wiersz. Oba są ilustrowane 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 komentarz wymaga więcej niż jednego wiersza, użyj symbolu komentarza w każdym wierszu, jak pokazano w poniższym przykładzie.

' 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 dotyczące komentowania

Poniższa tabela zawiera ogólne wskazówki dotyczące typów komentarzy, które mogą poprzedzać sekcję kodu. Są to sugestie; Visual Basic nie wymusza reguł dodawania komentarzy. Napisz, co działa najlepiej, zarówno dla Ciebie, jak i dla każdego innego, kto odczytuje twój kod.

Typ komentarza Opis komentarza
Przeznaczenie Opisuje, co robi procedura (nie jak to robi)
Założenia Wyświetla listę każdej zmiennej zewnętrznej, sterowania, otwartego pliku lub innego elementu, do którego uzyskuje dostęp procedura
Efekty Wyświetla listę każdej zmiennej zewnętrznej, kontrolki lub pliku oraz jej efekt (tylko wtedy, gdy nie jest oczywisty)
Dane wejściowe Określa przeznaczenie argumentu
Zwraca Objaśnia wartości zwracane przez procedurę

Zapamiętaj następujące kwestie:

  • Każda ważna deklaracja zmiennej powinna być poprzedzona komentarzem opisującym użycie zadeklarowanej zmiennej.

  • Zmienne, kontrolki i procedury powinny być nazwane wystarczająco wyraźnie, aby komentowanie było potrzebne tylko w przypadku złożonych szczegółów implementacji.

  • Komentarze nie mogą podążać za sekwencją kontynuacji wiersza w tym samym wierszu.

Możesz dodawać lub usuwać symbole komentarza dla bloku kodu, wybierając jeden lub więcej wierszy kodu i używając przycisków Komentarz (Przycisk Komentarz Visual Basic w programie Visual Studio.) oraz Usuń komentarz (Przycisk Usuń komentarz Visual Basic w programie Visual Studio.) na pasku narzędzi Edycja.

Uwaga / Notatka

Możesz również dodać komentarze do kodu, poprzedzając tekst REM słowem kluczowym . ' Jednak symbol i przyciski Skomentuj/Usuń komentarz są łatwiejsze do użycia i wymagają mniej miejsca i pamięci.

Zobacz także