DevProTalk

DevProTalk (http://www.devprotalk.com/index.php)
-   Opušteno (http://www.devprotalk.com/forumdisplay.php?f=16)
-   -   Kod kojem ne treba dokumentacija... (http://www.devprotalk.com/showthread.php?t=7950)

mangia 10. 10. 2009. 18:24

Kod kojem ne treba dokumentacija...
 
Kôd:

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 10. 10. 2009. 20:30

ali zato treba auto-complet u editoru :)

blackshtef 10. 10. 2009. 23:43

a lol :D

Dragi Tata 12. 10. 2009. 16:30

Citat:

Originalno napisao ivanhoe (Napišite 73965)
ali zato treba auto-complet u editoru :)

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

bluesman 12. 10. 2009. 16:40

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 12. 10. 2009. 17:06

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

bluesman 12. 10. 2009. 17:27

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 12. 10. 2009. 18:27

Citat:

Originalno napisao Dragi Tata (Napišite 73991)
Нисам сигуран да се слажем. Кад се промени код, често се заборави да се промени и коментар па више штете него користи. Мада, јесте мало предугачко и напорно за читање :)

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 12. 10. 2009. 18:36

Citat:

Originalno napisao bluesman (Napišite 73992)
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 12. 10. 2009. 20:40

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.


Vreme je GMT +2. Trenutno vreme je 04:51.

Powered by vBulletin® Verzija 3.6.8
Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
Copyright © DevProTalk. All Rights Reserved.

Mišljenja, saveti, izjave, ponude ili druge informacije ili sadržaji nastali na Sajtu su vlasništvo onoga ko ih je kreirao, a ne DevProTalk.com, tako da ne morate da se oslanjate na njih.
Autori poruka su jedini odgovorni za ovakve sadržaje. DevProTalk.com ne garantuje tačnost, kompletnost ili upotrebnu vrednost informacija, stavova, saveta ili datih izjava. Ne postoje uslovi pod kojima bi mi bili odgovorni za štetu ili gubitak koji je posledica bilo čijeg oslanjanja na nepouzdane informacije, ili bilo kakve informacije nastale kroz komunikaciju između registrovanih članova.
Web sajt može sadržavati linkove na druge web sajtove na Internetu ili neke druge sadržaje. Ne kontrolišemo niti podržavamo te druge web sajtove, niti smo pregledali bilo kakve sadržaje na takvim sajtovima. Mi nećemo biti odgovorni za legalnost, tačnost ili prikladnost bilo kog sadržaja, oglasa, proizvoda, usluga ili informacije lociranim na ili distribuiranih kroz druge web sajtove, niti za bilo kakvu štetu nastalu kao posledica takvih informacija. DevProTalk.com drži i čuva druga prava vlasništva na web sajtu. Web sajt sadrže materijale zaštićene copyright-om, zaštitne znakove i druge informacije o pravu vlasništva ili softver. Članovi mogu poslatu informacije zaštićene pravima vlasništva njihovih nosilaca i ona ostaju zaštićena bez obzira da li su oni koji prenose te informacije to naveli ili ne. Osim informacija koje su u javnom vlasništvu ili za koje dobijete dozvolu, nemate pravo da kopirate, modifikujete ili na bilo koji način menjate, objavljujete, prenosite, distribuirate, izvršavate, prikazujete ili prodajte bilo koju informaciju zaštićenu pravima vlasništva. Slanjem informacija ili sadržaja na bilo koji deo DevProTalk.com, Vi automatski dozvoljavate i predstavljate garanciju da imate pravo da dozvolite DevProTalk.com ili članovima DevProTalk.com bespovratnu, kontinualnu, neograničenu, globalnu dozvolu da koriste, kopiraju, izvršavaju, prikazuju i distribuiraju takve informacije i sadržaje i da iz takvih sadžaja koriste bilo koji deo u bilo koje svrhe, kao i pravo i dozvolu da koriste gore navedene sadržaje. Svi zaštitni znakovi (trademarks), logotipi, oznake usluga, firme ili imena proizvoda koji se pominju na ovom web sajtu su vlasništvo kojim raspolažu njihovi vlasnici.