Giriş

Yorumlar, iyi yerleştirilmişlerse programlamada aslında çok faydalıdır. Ancak çoğu zaman yorumlar o kadar "iyi" değildir.

Kötü yorumlar yanlış bilgilendirmeye, zaman kaybına, kötü alışkanlıklar yaratmaya vb. sebep olabilir.

Bu yazıda, kötü yorum yazmaktan nasıl kaçınacağınız konusunda size rehberlik edeceğim.

Kötü Yorumlar

Güncel olmayan yorumlar

Eskimiş, modası geçmiş, alakasız veya yanlış bilgi veren yorumlar. Yorumlar çok çabuk eskiyebilir, çünkü kod tabanı her gün değişebilir, teknoloji her gün değişebilir.

Nasıl çözülür:

• En kısa sürede güncelleyin
• Sil onu aslında

Yanlış dilbilgisi, çok fazla işaretçi, mırıldanma, topallama kötü yazılmış. Temiz koda göre, yazmaya değer bir yorum iyi yazmaya değer. Bir tane yazacaksanız, cilalamak için zaman ayırın ve kelimelerinizi dikkatlice seçin.

Yorumlanan kod

Bu, yorumların en kötüsü, yorumlanmış bir kod parçası gördüğümde beni çıldırtıyorlar. O kod hiçbir şey yapmadı, orada oturdular ve çürüdüler. Ama kimse ne zaman sileceğini bilmiyor çünkü “belki birinin ihtiyacı olur”

Nasıl çözeceksin? Sadece sil ! Git bugünlerde çok değerli hale geldi, birinin gerçekten ihtiyacı varsa onu bulabiliriz

Gereksiz yorumlar

Bunlar da korkunç, şuna bakın:

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}

Sadece onları silin .

Gürültülü yorumlar

Bazı yorumlar sadece gürültülü. Hiç böyle yorumlar gördünüz mü?

// 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.

HTML Yorumları

Bu konuda söylenecek fazla bir şey yok, HTML yorumlarının hiç kullanışlı olduğunu düşünmüyorum. Bir kodun anlamını söylemenin kimliği, sınıf adı, etiket adı ve daha binlerce yolu var. Zaten onlar için yorum yazmaya ne gerek var?

Çözüm

Bazı yorumlar aslında gerekli ve faydalı olsa da, yorumların çoğu değildir. Bu makalenin belki o kadar olumlu olmadığını biliyorum, ancak şunu haklı çıkarmak istiyorum:

Kodunuz kötüyse, bunun için yorum yapmayın, sadece temizleyin

Bir sonraki yazıda nasıl iyi yorum yazılacağı hakkında yazacağım, ileride kontrol etmek için lütfen takip düğmesine basın.

okuduğunuz için teşekkürler

Son sözler

İçeriğim herkes için ücretsiz olsa da bu makaleyi faydalı bulursanız bana buradan bir kahve ısmarlayabilirsiniz.