Neden herkes büyük harflerle yapılacaklar yorumları yazıyor? [kapalı]

9

Ben de aynısını yapıyorum. Kodumda "yapılacak" bir şey olduğunda yazıyorum //TODO .... Ama bunun ne zaman başladığını ve tüm büyük harflerle "yapılacaklar" yazmanın bir nedeni olup olmadığını merak ediyorum?

comments

— Mohsen
kaynak

20

Çünkü biz gerçekten ANLAMIYORUZ (aslında ona asla

— ulaşamıyoruz

3

böylece editörler onları işaretleyebilir ve aralarında arama yapmanıza izin verebilir (örneğin, tutulmanın görev listesi)

— cırcır ucube

6

Gerçekten kod içinde metin kalın yapamadı çünkü önemli şeyler öne çıkarmak için bir yol gerekiyordu. Bu nedenle ...

— Karlson

4

Neden fark eder?

— Kale

3

Ben yazıyorum//todo:...

— BЈовић

23

Ayrıca, göz attığınız ve geri dönmek istediğiniz kod bölümlerini kolayca aramak için bir yol bulmak harika. Daha önce atladığınızı hemen bulmak için "TODO" için büyük / küçük harfe duyarlı bir arama yapabilirsiniz.

"todo" (küçük harf) muhtemelen daha büyük bir sözcüğün / fonksiyonun / değişkenin parçası olabilir, ancak "TODO" (büyük harf) muhtemelen olmayacaktır.

— Buttle Butkus
kaynak

4

Ayrıca editörlerin bunu vurgulamasına da izin verir. Örneğin, gedit bunu yapar ve sadece büyük harflerle yapar TODO. Sebep ne olursa olsun, büyük harfle yazmam için yeterince teşvik edici.

4

@delnan: Bu bir totoloji. Çıkarmak için yapıldı, bu yüzden insanlar kullandı, bu yüzden biri daha fazla öne çıkmak için vim'de vurgulanan sözdizimini ekledi, böylece insanlar öne çıkmak için kullanıyor. İnsanlar bunu kullanmaz, çünkü editör onu öne çıkarır, çünkü bunu yapmak yaygındır ve bu nedenle editör onu öne çıkarır. Vim'de göze çarpan herhangi bir şeyi yapabilirsiniz, sözdizimini uygun şekilde vurgulayarak değiştirin, öne çıkması da kolaydır, todoancak konvansiyonun TODO'yu kullanmak olduğu için çok az nokta vardır.

— Martin York

1

@LokiAstari: Dediğim gibi, biri için büyük harflerle heceliyorum çünkü daha fazla editör varsayılan olarak bunu vurgulamaktadır. Ama belki de bir istisnayım: Oldukça genç (bu yüzden editörler desteklemeden önce yapamazdım ) ve (ne yazık ki) sözdizimi vurgulamayı manuel olarak ayarlamak için çok fazla kapris ve tembel serseri.

Ayrıca sizden sonra temizlenmesi gereken zavallı adam ve tamamlanmadan önce kodunuzu gözden geçirmesi gereken herkes için de güzel. Bu sözleşmeden dolayı henüz yapılmayanları bir bakışta görebilirler.

— sq33G

2

Gibi bir değişken adı içinde karışık durum TODO ile karşılaştım filesToDownload. Elbette "yalnızca tam kelimeler" araması bu sorunu çözer.

— dan04

8

Bunun ne zaman başladığını ve yapılacak tüm sermayeyi yazmak için bir neden olup olmadığını bilmek için merak ediyorum?

TODO ve FIXME gibi yorumların fikri, onları ortaya çıkarmaktır. Genellikle kodda bu tür işaretleyicilere sahip kodlar göndermek istemezsiniz - proje tamamlanmış olarak değerlendirilmeden önce yapılması gerekenleri işaretlerler. Kodunuzdaki diğer pek çok şey için ALL CAPS'ı kullanmamanız koşuluyla, ALL CAPS'ı kullanmak onları biraz daha kolay hale getirir.

— Caleb
kaynak

5

Hem Eclipse hem de Visual Studio, içinde TODO bulunan yorum satırlarının listesini otomatik olarak veren Görev Listesi özelliklerine sahiptir.

— O. Jones
kaynak

Visual Studio // TODO: yorumlarını yapmaya başladı ve MFC kaynak plakası için kod üreteçlerini ilk kez ekledi. Bu sürüm 2.0, iirc idi.

— 05'te mjfgates

en azından Visual studio için bu arama büyük / küçük harfe duyarlı değildir - // todo foo'yu görev listesine de çekecektir

— jk.

4

Sadece öne çıkıyorum ve yakalaması kolay ... karmaşık bir şey yok!

— bunglestink
kaynak

1

bu ve grep ya da benzeri aracılığıyla bulmak kolay

— Zachary K

@ZacharyK: Kesinlikle!

— Dinamik

1

Bir todo'nun varlığına dikkat çekiyor .

Birinin koda geri dönmesi gerektiğinin her zaman açık olması önemlidir. Ayrıntıların sadece sorunun ne olduğunu ele almak için geri gelen kişi tarafından bilinmesi gerekir.

— yfeldblum
kaynak

1

Bir vi kullanıcısıysanız:

/YAPMAK

Seni oraya çok hızlı götürecek.

— ncmathsadist
kaynak

Diğer editörlerin arama özellikleri vardır ve todo'yu kolayca arayabilirsiniz .

— Karlson

'Todo' hariç, değişken adı veya başka bir yorum metni gibi başka bir şeyde görünebilir ...

— sevenseacat

1

vi büyük / küçük harfe duyarlıdır. Büyük harflerin çoğu modern dilde (adlandırılmış sabitler gibi) az miktarda kullanıldığından, arama yüksek bir başarı olasılığına sahiptir.

— ncmathsadist

1

Bazı editörler yalnızca büyük TODO öğelerini vurgular, bu nedenle her zaman büyük harf kullanmak daha güvenlidir.

— Tim Abell
kaynak

0

Görsel olarak TÜM CAPS göze çarpıyor, ancak çok okunaklı değil. Kodu okurken belirli bir boyutta bir blok olarak tararlar. Harflerin ne olduğu gerçekten önemli değil. Sadece öne çıkıyorlar ve çok hızlı bir şekilde görülebilirler. Bir süredir etiketlerle çalıştıktan sonra, beyniniz kelimeyi şekil olarak tanıyacaktır.

Araçlar (IDE / Editör) açısından, büyük / küçük harfe duyarlı arama, tüm büyük harf sürümlerinde çok düşük bir yanlış pozitif orana sahip olacaktır. Bazı kodlama stillerinde, bir sabitin eşleşmesi riski düşüktür. Büyük / küçük harfe duyarlı tam kelime arama, yanlış pozitifleri daha az olası hale getirir.

Araç ekrana geldiğinde, biçim açıkça BURAYA bak diyor. Konuma odaklandığınızda, okunaklı bölüm ilgili yorum olacaktır.

— BillThor
kaynak