Kod kojem ne treba dokumentacija...

[mangia]

switch (mIntegrationDirection)
{
   case InventoryIntegrationDirection.DoTheSameChangeInShop:
      DoTheSameChangeInShop(GetChangedDataFromInventory(mLastSynchDate));
      break;

   case InventoryIntegrationDirection.DoTheSameChangeInInventory:
      DoTheSameChangeInInventory(GetChangedDataFromShop(mLastSynchDate));
      break;

   case InventoryIntegrationDirection.DoTheSameChangeInShopThenDoTheSameChangeInInventoryForNotChangedDataInInventory:
      DoTheSameChangeInShopThenDoTheSameChangeInInventoryForNotChangedDataInInventory(
	   GetChangedDataFromInventory(mLastSynchDate), 
	   GetChangedDataFromShop(mLastSynchDate));
      break;

   case InventoryIntegrationDirection.DoTheSameChangeInInventoryThenDoTheSameChangeInShopForNotChangedData:
      DoTheSameChangeInInventoryThenDoTheSameChangeInShopForNotChangedData(
	   GetChangedDataFromShop(mLastSynchDate), 
	   GetChangedDataFromInventory(mLastSynchDate));
      break;

   default:
      break;
}

[ivanhoe]

ali zato treba auto-complet u editoru

[blackshtef]

a lol

[Dragi Tata]

Originalno napisao ivanhoe

ali zato treba auto-complet u editoru

Па који едитор то данас нема? Да не користиш Notepad?

[bluesman]

Da koristi i NASA editor glupo je da se funkcija zove: DoTheSameChangeInShopThenDoTheSameChangeInInventor yForNotChangedDataInInventory

Treba 20 sekundi samo da se pričita naziv, bolje je da je onda napisao komentar.

[Dragi Tata]

Нисам сигуран да се слажем. Кад се промени код, често се заборави да се промени и коментар па више штете него користи. Мада, јесте мало предугачко и напорно за читање

[bluesman]

Ako već promeniš kod, odnosno ono šta ta funkcija radi - pošto je tako "opsino" ime funkcije onda ćeš SIGURNO morati da menjaš i ime funkcije što je još gore nego menjati komentar, zar ne?

[holodoc]

Originalno napisao Dragi Tata

Нисам сигуран да се слажем. Кад се промени код, често се заборави да се промени и коментар па више штете него користи. Мада, јесте мало предугачко и напорно за читање

Zbog toga se nijedan od poznatijih sistema za dokumentovanje koda (phpDocumentor, javaDoc...) ne oslanja direktno na nazive elementa koji dokumentuje (funkcije, metode itd.) već se oni "kupe" u toku procesa kompajliranja dokumentacije čime se efektivno eliminiše navedeni problem. Isto tako ako se i dogodi da postoje nesuglasice između iskomentovanog koda i stvarnog koda veoma lako se može podesiti da prilikom kreiranja dokumentacije kod uvek ima prednost nad postojećom dokumentacijom.

[Dragi Tata]

Originalno napisao bluesman

Ako već promeniš kod, odnosno ono šta ta funkcija radi - pošto je tako "opsino" ime funkcije onda ćeš SIGURNO morati da menjaš i ime funkcije što je još gore nego menjati komentar, zar ne?

У ствари мислим да итекако има смисла променити име функције ако се промени оно што та функција ради.

[bluesman]

Naravno, ako imas ovakvo tupavo ime koje je u stvari komentar - onda moras. Zato se i ne daju takva imena.

Sve je vrlo slično onom CSS primeru kojim najlakše objasnim poentu dobrih imena. Većina CSS kodera voli da daje imena klasama: big, small, red, green ... i onda dođe manager i kaže "nemoj ovo crveno, neka bude plavo" i tako završimo sa CSS klasom "red" koja boji tekst u plavo. To sam video mnogo puta. I onda ćeš ili da trpiš tako ili da menjaš kod.

Zato ja i za funkcije ne volim previše opisna imena... Cart::update, Inventory::update... sasvim dovoljno, ne mora u imenu funkcije da piše šta se radi tamo.