Aby prawidłowo udokumentować linię kodu języka Java Script, należy po znakach // wpisać komentarz

Wyjaśnienie

Komentarz po znakach // powinien krótko i rzeczowo wyjaśniać, co robi dana linia kodu. W tym przypadku instrukcja x = Math.max(a, b, c); wywołuje metodę Math.max, czyli wbudowaną funkcję JavaScript zwracającą największą wartość spośród przekazanych argumentów. Jeżeli na przykład a = 4, b = 12, a c = 7, to do zmiennej x zostanie przypisana liczba 12. Dlatego komentarz w stylu: w zmiennej x maksymalna wartość ze zmiennych a, b, c jest poprawny i dobrze opisuje sens operacji. Moim zdaniem to jest też fajny przykład dobrego komentarza: nie tłumaczy każdego znaku składni, tylko mówi, jaki jest efekt działania kodu. W praktyce komentarze warto pisać tam, gdzie kod może nie być od razu jasny, np. przy obliczeniach, warunkach biznesowych albo nietypowych założeniach. Zgodnie z dobrymi praktykami branżowymi komentarz powinien być aktualny, krótki i pomagać w utrzymaniu aplikacji, a nie powtarzać bezmyślnie kodu. W JavaScript // oznacza komentarz jednoliniowy, więc wszystko po tych znakach do końca linii nie jest wykonywane przez interpreter.