2013-01-16 13 views
10

Birçok yazılım mühendisi, kod açıklamalarına eklenebilecek özel "yorum" yorumlarının kullanımını, aramalarda kullanmak, otomatik görev takibi vb. Hakkında bilgi sahibidir. En popüler olanlardan bazıları FIXME, TODO, UNDONE ve HACK'dir.HACK ve UNDONE açıklama etiketlerinin kullanımı

HACK ve UNDONE etiketlerinin kullanımı konusunda biraz kafam karışık. Biraz yardım lütfen? FIXME ve TODO arasındaki temel farkı göstermek için

Bonus puan

+6

Pers bulunuyor onca favori benim favori değil. –

cevap

14

Benim anlayış:

  • YAPILACAK: Yapılması gereken bir şey. Bu daha sonra eklenecek bir özellik veya bir şeyin bir saplama olduğunu ve uygulanmasının gerekli olduğunu belirtebilir.

  • FIXME: TODO etiketinin bir alt sınıfı, bir şeyler belirten sabit olması gerekiyor kırık olduğunu.

  • UNDONE: Başka bir değişikliğin geri alınması veya ters çevrilmesi olan değişikliği belirtmek için bir not. Bu yorum genellikle neyin kaldırıldığını ve neden olduğunu gösterir. HACK: Belirli bir sorunu gidermek için eklenen, genellikle garip veya alışılmadık bir kod parçası olan bir şey. Bunlar genellikle "zarif" çözümler değildir, ancak yine de, şeytan işini yaparlar. Çoğunlukla bunları, çerçevedeki bir hatayı veya diğer beklenmedik davranışları ele almak için görürsünüz. Ek olarak, yorumlanan kodun amacı genellikle yorum için açık değildir. Bana

-1

çözülmek yöntemi bitmiş değil demektir, genellikle bazı insanlar bir ters düşünün çünkü bu demek istedim

hiçbir iç kod rağmen veri türünü döndürür i kirletmez olmaz yorumların bu türlü kod ve diğer birçok kişi çözülmek kullanmak gibi bir his var aynı anlama konusunda bana

o liberal bir kural seti var ama büyük bir sistemi

public int SomeCalculation(int Input) 
{ 
    return 0; //UNDONE 
} 

public bool SomeCheck() 
{ 
    return false; //UNDONE 
} 
+1

Bu, fiilin başka bir yorumu, ancak neden sadece TODO kullanmıyor. O zaman belirsizlik yok. –

+0

UNDONE ve TODO arasındaki fark, UNDONE'nun devam eden bir çalışma olduğu ve başka bir devreyle dokunulmaması gerektiği ve TODO'nun henüz başlatılmamış olması ve başka bir devin alması için daha özgür olması. –