Bilgilendirici yorumları yorumlanmamış koddan ayırt etmek için bir yöntem var mı?

Programlama boyunca, kodu açıklayan bazı yorumlar ve kodu kaldıran bazı yorumlar ile biteceksiniz:

// A concise description 
const a = Boolean(obj);
//b = false;

Hangisinin hızlı bir şekilde ayrıştırılması için iyi bir yöntem var mı?

3 /'ü kullanarak ve /** */açıklayıcı yorumlar için oynadım .

Ayrıca vurgulamak için bir VSCode eklentisi kullandım //TODO:ve//FIXME:

Bunun çok basit bir çözümü var: yorumlanan kodu kaldır.

Gerçekten, kodu yorumlamak için iki iyi neden var: bir şeyi test etmek / düzeltme yapmak veya daha sonra kullanabileceğiniz kodu kaydetmek için. Bir şeyi test ediyor veya düzeltiyorsanız, yorum veya kodu tamamladığınızda yorumlanan kodu kaldırın. Daha sonra kullanacağınız bir kodu kaydediyorsanız, birinci sınıf bir kod yapın ve kütüphane gibi iyi bir şekilde kullanılabilecek bir yere koyun.

@ RobertHarvey'in mükemmel cevabına ekleme Yaptığım yorumların kodunu geçici olarak bile olsa kontrol etmek için kaydettiğim tek meşru sebep olduğuna inanıyorum: şu anda bir nedenden ötürü kullanılmaması gereken veya kullanılmaması gereken bariz bir değiştirme kodu olması durumunda . O zaman bile, yorumların çoğu değiştirme kodu değil açıklama olmalıdır . Bu bir dil ya da henüz kararlı sayılmayan bir dilin bir özelliği olabilir. Böyle bir şeye benzeyebilir:

# TODO: Replace with `foo = frobnicate(bar)` once <link.to/bug> is fixed
foo = [some complex workaround]

Bu durumda, çalışma zaten yapıldı, ancak siz bundan faydalanamazsınız, bu nedenle silme birisinin daha sonra yeniden keşfetmesi gerektiği anlamına gelir. Aynı şey , yüzünde daha üstün görünebilecek düşük kaliteli çözümler veya benzer çözümlere karşı bilinçli takaslar için de geçerlidir .

Dikkat: Kodunuzu alternatif çözümlerle karıştırmayın. Her görev sonsuz farklı şekillerde yapılabilir ve bu alanı her değişiklik için uzun süre keşfetmek uygun değildir. Kod incelemeleri, meslektaşınız daha önce yetersiz olduğunu keşfettiğiniz bir iyileştirmeyi önerdiğinde, bu gibi eksik yorumları keşfetmek için iyi bir yer olabilir.

Hmm, bu soruyu Robert’tan biraz farklı bir şekilde okudum ve doğru bir şekilde kodun kaldırılması gerektiğini söyleyen var.

Bununla birlikte, daha sonra kaldırılmak üzere kodu işaretlemek için bir sözleşme arıyorsanız, eski bir favorim:

//b = false; //TODO: remove

Bazı IDE'nin bayrağı //TODO:yorumlar veya öğretilebilir. Değilse, genellikle aranabilir bir dizedir. Mağazanızın oluşturduğu her türlü konvansiyonu takip etmek en iyisidir çünkü bu birkaç şekilde yapılabilir. Her kod tabanı bunu tek yönlü yapmalıdır. Aranabilir tutar.

Çabuk ayrıştırmak hangisi?

Bu işaret olmadan bunu yapmanın otomatik yolu derleyici ile. Yorumun kaldırılması derleyen kod üretiyorsa, yorumlanmış olması gerekir. Zor olmayan kontrolleri yapan bir IDE eklentisi yazmak. Ama buggy yorum kodunu geride bırakacak.

Bu nedenle, yorumlanan kodu, yorum yaptığınız an kod olarak işaretlemeniz daha iyi olur. Bu, gerçekten gitmesini isteyip istemediğinize karar verirken zarar vermeden çalışmanıza olanak tanır. Hepimiz kesintiye uğradığından ve biraz unutkan olduğundan, bu durumda bazı çizgiler kontrol edilirse şaşırmayın. Yaparlarsa en azından açıkça işaretlenmiş ve aranabilir olmaları güzel. Klavye makroları geçmişte bu konuda bana yardımcı oldu. Tek bir tuşa dokunarak yapabiliyorsanız, bunun ortasında kesintiye uğramak zor.

Bunu, sürekli entegrasyon testlerinizde işareti taşıyan noktaya kadar alabilirsiniz. Hata! Olağanüstü TODO'ları tekrar kontrol etmeye çalışıyorum.

Hiçbir kodu değil, kodu kaldırmak için önişlemci yönergelerini kullanıyorum:

//comment
active_code();
#if FALSE
inactive_code();
#endif

Bu, aranması çok kolay bir şey yapar ve sözdizimi vurgulayıcım yorum olarak değerlendirir. Hatta tek bir satıra daraltabilirim:#if FALSE(...)

Birkaç seçeneğe sahip olmak için bu fikri genişletebilirsiniz:

#if OPTION == 0
code_for_option_0();
#elif OPTION == 1
code_for_option_1();
#else
code_for_all_other_options();
#endif

Ve derleme zamanı hata denetimi:

#if FOO >= 5
#error FOO should be less than 5!
#endif

Tabii ki, bu konuya aşırıya atılmak istemiyorsunuz, ya da neyin derlenip neyin toplanmadığını söylemek zorlaşıyor. Ama bu fikri anladınız ve bu yorumlanmış kodla aynı problemi ... sadece statik olarak kullandığınız sürece. Koşullarınız dinamikse daha kötüsüdür.

Hangisinin bu sorunu hiç dikkate almadığı hangisinin hangisi olduğunu belirlemek için, evrensel bir çözüm olduğunu sanmıyorum. Modelleri kendiniz bulmanız ve muhtemelen onları bulmak için bir regex kodlamanız gerekir.

Mümkün olan yerlerde yorum yapmak yerine eski kodun kaldırılması gerektiğini belirten cevabı kabul ediyorum, ancak yorumlanan kod gerektiğinde bu birkaç durum için bir sözleşme gözlemledim.

(Benim temelim C # ama bu herhangi bir C sözdizim diline uygulanabilir, örneğin java)

// An explanatory comment has a space between the comment marker and the content.

// The following lines are commented out code so do not have the space (except where indented).
//var a = something();
//if(a==2) {
//   doSomethingElse();
//}

Soruyu farklı yorumluyorum, yorumlanmış kod bulmak istediğinizi düşünüyorum.

C tarzı kodun içinde yarım virgül olması, yorumda ise yarım virgül olması olası değildir. Böylece, tek satırlı yorum kodu için bu normal ifadeyi kullanabilirsiniz:

\s*\/\/[\s\S]*;

Çok satırlı yorumlu kod için bu olabilir

\/\*[^\;]*;[^\;]*\*\/

Not Visual Studio, düzenli ifadelerdeki satır sonları konusunda biraz tuhaf, boş alan olarak sayılmaz, açık bir şekilde belirtmeniz gerekir \ n.

Arka planda çalışan bir derleyiciye sahip bir düzenleyici kullanıyorsanız (Xcode ve Clang gibi), yorum metnini derlemeyi deneyebilirsiniz. Örneğin “kısa bir açıklama” hata veriyor, “b = false;” yazmıyor. Daha sonra farklı sözdizimi vurgulamayı kullanabilirsiniz.

Daha basit bir yöntem, bazı sezgisel taramaları kullanan bir IDE eklentisidir, örneğin, anahtar kelimelerden yorumlara, satırlardan kodlara eşleştirilmiş kıvrımlı kıvrımlı noktadan başka birçok kelime gibi.

Diğer cevaplar, “kod hakkında yorum yapma” temasının varyasyonlarını kapsamıştır. Ama bazen hala referans olarak buralarda olmanı istiyorsun.

Kodun etrafında kalmak için gerçekten ihtiyacınız varsa, kodu "#if 0 ... #endif" ile çevrelemek için daha iyi bir çözüm, idealini nedenini söyleyen bir yorumla. MISRA dahil olmak üzere çeşitli kodlama standartlarından önerilen strateji budur.

Basit, en azından benim için - ve C / C ++ dilinde. / * * / İçinde yer alan yorumlar bilgi vericidir. Geçici olarak kaldırılan test kodu, baştaki // ile yorumlanmıştır.

Ve test kodunu dosyada bırakmak için iyi bir neden var ama yorumda bulundum, en azından yaptığım işe göre. Er ya da geç birileri bir değişiklik yapmak isteyecek ve bu koda ihtiyaç duyacak. Bir bloğun yorumunu kaldırmak, tamamladığınız yere yeniden yorum yapmak gibi tek bir editör komutu alır.