Itqualityassurance
- Kiedy powinniśmy używać komentarzy wbudowanych?
- Jaka jest różnica między pełnym komentarzem liniowym a komentarzem wbudowanym?
- Co to jest wbudowany komentarz?
- Czy lepiej umieścić komentarz powyżej lub poniżej wiersza kodu?
Kiedy powinniśmy używać komentarzy wbudowanych?
Wbudowane komentarze to wszystkie komentarze nie zawarte w blokach DOC. Celem komentowania w linii jest wyjaśnienie kodu w kontekście. Takie wyjaśnienie może przybierać wiele różnych form. Zachęcane są komentarze zapisane w czytelnym i narracyjnym stylu, zwłaszcza gdy wyjaśniają złożony proces.
Jaka jest różnica między pełnym komentarzem liniowym a komentarzem wbudowanym?
Odpowiedź: Komentarze pełnego wiersza Weź pełny wiersz, a komentarze wbudowane udostępnij wiersz z oświadczeniem lub wyrażeniem.
Co to jest wbudowany komentarz?
język angielski. Wbudowane komentarze to komentarze instruktora, który pojawia się bezpośrednio na twoim artykule. Te komentarze są zwykle krótkie.
Czy lepiej umieścić komentarz powyżej lub poniżej wiersza kodu?
Dla prostych notatek o indywidualnej linii, zazwyczaj obok. W przypadku dużych kawałków powyżej, więc wiesz, czego się spodziewać. Ogólnie rzecz biorąc, że ludzie będą chcieli przeczytać komentarz, który wyjaśnia, jak interpretować kod przed przeczytaniem kodu. W przypadku mniejszych notatek trzymam je na tej samej linii.
