Wstęp

Komentarze są w rzeczywistości bardzo przydatne w programowaniu, jeśli są dobrze umieszczone. Ale przez większość czasu komentarze nie są tak „dobre”.

Złe komentarze mogą prowadzić do dezinformacji, marnowania czasu, tworzenia złych nawyków itp.

W tym artykule poprowadzę Cię, jak uniknąć pisania złych komentarzy

Złe komentarze

Nieaktualne komentarze

Komentarze, które się zestarzały, są nieaktualne, nieistotne lub zawierają błędne informacje. Komentarze mogą się bardzo szybko zestarzeć, ponieważ baza kodu może się zmieniać każdego dnia, technologia może się zmieniać każdego dnia.

Jak rozwiązać:

• Zaktualizuj go jak najszybciej
• Po prostu usuń to, naprawdę

Niepoprawna gramatyka, zbyt wiele znaczników, bełkot, bełkot są po prostu źle napisane. Zgodnie z czystym kodem, komentarz wart napisania jest wart napisania dobrze. Jeśli zamierzasz coś napisać, poświęć trochę czasu na dopracowanie go i starannie dobieraj słowa.

Skomentowany kod

To najgorszy rodzaj komentarzy, doprowadzają mnie do szału za każdym razem, gdy widzę fragment kodu, który został skomentowany. Ten kod nic nie zrobił, siedzieli tam i gnili. Ale nikt nie wie kiedy to usunąć, bo „może komuś się przyda”

Jak to rozwiązać? Po prostu to usuń ! W dzisiejszych czasach Git stał się bardzo cenny, możemy go znaleźć, jeśli ktoś naprawdę tego potrzebuje

Zbędne komentarze

Te też są okropne, spójrz na to:

for(let i = 0; i < 10; i++){
  a = b // assign a to b
}

// a function returns sum of a and b
function sum(a, b){ return a + b}

Po prostu je usuń .

Głośne komentarze

Niektóre komentarze są po prostu głośne. Widziałeś kiedyś takie komentarze?

// the name
private String name
// the version
private String version
// the constructor
constructor()

//The 123213 License
//
//Copyright (c)123213213213213, and Contributors
//
//Permission to use, copy, modify, and/or distribute this software for any
//purpose with or without fee is hereby granted, provided that the above
//copyright notice and this permission notice appear in all copies.
//
//THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
//WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
//MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
//ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
//WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
//ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
//IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Komentarze HTML

Nie ma wiele do powiedzenia na ten temat, nie sądzę, aby komentarze HTML były w ogóle przydatne. Mamy identyfikator, nazwę klasy, nazwę znacznika i tysiące innych sposobów na określenie znaczenia kodu. Po co w ogóle zawracać sobie głowę pisaniem komentarzy dla nich?

Wniosek

Chociaż niektóre komentarze są rzeczywiście konieczne i korzystne, ale większość komentarzy nie. Wiem, że ten artykuł może nie jest tak pozytywny, ale chcę tylko to uzasadnić:

Jeśli twój kod jest zły, nie komentuj go, po prostu go wyczyść

W następnym artykule napiszę o tym, jak pisać dobre komentarze, kliknij przycisk follow, aby sprawdzić to w przyszłości.

Dziękuje za przeczytanie

Ostatnie słowa

Chociaż moje treści są bezpłatne dla wszystkich, ale jeśli uznasz ten artykuł za pomocny, możesz postawić mi kawę tutaj