Kod yorumlarında #XXX'in anlamı nedir?

Bunu kodda çok gördüm, hatta vim bunu özel bir durum olarak işaretliyor. #TODOve #FIXMEdiğer iki düzeltme işaretçisi öne çıkıyor ama ne anlama #XXXgeliyor?

XXXbir yorumda genellikle bir uyarıdır. Olabilir:

• Tamamen doğru uygulanmayan bir şey.
• Daha sonra düzeltilmesi gereken bir şey.
• Olası bir sorun noktasını vurgulamak.
• Emin olmadığınız bir şey, bir soru.

Genellikle FIXMEveya TODOveya gibi daha açıklayıcı bir etiketi tercih ettim HACK. XXXgenellikle yukarıdakilerin tümü için bir yakalama olarak kullanılır.

FreeBSD çapraz referans kodunda 'XXX' araması , birçok kullanıma iyi bir örnektir. Binlercesi var...

• NOTE: Kodun nasıl çalıştığının açıklaması (kendiliğinden belli olmadığında).
• XXX: Olası tuzaklarla ilgili uyarı, olarak kullanılabilir NOTE:XXX:.
• HACK: Bir problemi / hatayı aşmak için çok iyi yazılmamış veya yanlış biçimlendirilmiş kod. Olarak kullanılmalıdır HACK:FIXME:.
• FIXME: Bu işe yarıyor, ancak daha iyi yapılabilir. (genellikle yeniden yazılması gereken aceleyle yazılmış kod).
• BUG: Burada bir sorun var.
• TODO: Sorun değil, ancak genellikle bir şeyi atladığınızda ek kod yazılması gerekir.

En azından bu etiketler hakkında bana bu şekilde öğretildim. Temel olarak ilk ikisi ( NOTEve XXX) bilgi için kullanılır ve herhangi bir işlem yapılması gerekmez. Son üç iken ( FIXME, BUGve TODO) eylemi gerektirir. HACKarada bir yerde (ve neredeyse hiç kullanılmadığını düşünüyorum?).

Haziran 2005 Python Geliştirme Önerisinden reddedilen bazı notlar .

Arasında seçim yapma FIXMEve XXXzordur.
XXXdaha yaygın görünüyor, ancak çok daha az açıklayıcı.
Ayrıca, bilinmeyen bir değere sahip bir XXXkod parçasında yararlı bir yer tutucudur
.

Bu FIXME, tercih edilen yazımdır.
Sun bunu söylüyor XXXve FIXMEbiraz farklı, daha XXXyüksek şiddet veriyor .
Bununla birlikte, bu konudaki on yıllarca süren kaos ve
Sun'dan etkilenmeyecek çok sayıda milyon geliştiriciyle, onları doğru bir şekilde eş anlamlı olarak adlandırmak kolaydır.

PEP şununla başlar:

Bu PEP reddedildi. Topluluk ilgilense de
, standart kütüphaneyi bu standarda uydurma arzusu yoktur.

...

Kod Etiketleri Nedir?

Programcılar, daha yakından inceleme veya inceleme gerektiren kod bölümlerinin hatırlatıcıları olarak hizmet etmek için geçici kod yorumu işaretleme kurallarını yaygın olarak kullanır. İşaretleme örnekleri FIXME, TODO, XXX, BUG, mevcut yazılımda yaygın olarak kullanılmakta ve orada çok daha fazla ama. Bu tür işaretleme bundan böyle kod etiketleri olarak anılacaktır . Bu kod etiketleri, uygulama kodunda, birim testlerinde, komut dosyalarında, genel belgelerde veya uygun olan yerlerde görünebilir.

PEP ilginç bir okumadır.

PEP350'ye bir göz atın . Bu tüm açıklar TODO, XXXben kod etiketleri araçlarının tam olarak ne hatırlayamıyorum zaman vb ben o gün kullanın.

Kullanıyorum XXXçünkü yazmaktan daha kolay TODO.

XXX aceleniz olduğu ve buna kendiniz döneceğiniz zamanlar içindir.

TODO başkasına devretmeniz gerektiğinde.

Muhtemelen nasıl halledileceğini bilmediğin durumlar içindir. Şuna bir göz
atın: TODO / FIXME / XXX / HACK ifadelerinin liste görünümü

alternatif metin http://editra-plugins.googlecode.com/svn/wiki/images/commentbrowser/cb_screenshot.PNG

(Eski) Java kodu kurallarından :

Sahte olan ancak işe yarayan bir şeyi işaretlemek için bir yorumda XXX kullanın. Sahte ve bozuk bir şeyi işaretlemek için FIXME'yi kullanın.

XXX, NOT'dan biraz farklı olan ancak HACK'e oldukça benzeyen uyarı için kısadır. Kullanılmakta olan bir üçüncü taraf kitaplığında / kodunda bir hata olabilir ve // ​​XXX: kod, bunun üçüncü taraf kodundaki bir hatadan dolayı geçici çözüm olduğunu veya arayan / değiştiren biri için "dikkat" anlamına gelebileceğini gösterir bir şeyin neden belirli bir şekilde yapıldığını gösteren kod, aksi takdirde ilk bakışta yanlış / uygunsuz görünebilir. HACK, kendi kod tabanınızda veya bir üçüncü taraf kitaplığında bulunabilecek bir sorun için geçici çözüm anlamına gelen genel bir terimdir.

Ben ise iman FIXMEgeliştirici içindir ve HACKsürdürücü içindir XXXkullanıcı içindir.

Örneğin, XXXnasıl çalıştığını anlamadan, bu işlevi görmezden gelirseniz ve başka bir yerde çağırırsanız, beklenmedik bir şey olabilir ve bu konuyla ilgilenen kişi mutsuz olacaktır (en azından bunu XXXdüşünen kişi). Bu işlevi kullanmazsanız sorunun çözüleceğini düşünebilirsiniz.

Ancak FIXME, çalışmasını sağlamak için kodu düzeltmeye layık hissedeceksiniz. Ve HACKkullanmasanız bile daha iyi bir seçeneğiniz olmayabilir.

XXXKendi kodunuz üzerine yazdıysanız ve birisi onu kullandıysa, bu kodu tamamen yeniden yazdığınız gibi nedenlerden dolayı kendinizi mutsuz hissedebilirsiniz ve sonra tamamen farklı şekillerde davranır ve bir başkasının kodunu kırarsınız. Ama eğer bir FIXMEveya TODOyerine bırakırsanız, bu kadar umursamayacaksınız.

// XXX kullanıyorum, böylece satır numaralarını hatırlamak zorunda kalmam. Bunun yerine, o kod parçasına dönmek istediğimde sadece XXX için arama yapıyorum.