|
Opušteno Trenutak za pauzu - Ćaskanje. Sponzor: |
|
Alati teme | Način prikaza |
10. 10. 2009. | #1 |
Pukovnik u penziji
Grand Master
|
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; } |
10. 10. 2009. | #2 |
Ivan Dilber
Sir Write-a-Lot
|
ali zato treba auto-complet u editoru
__________________
Leadership is the art of getting people to want to do what you know must be done. |
"Hvala" ivanhoe za poruku: |
10. 10. 2009. | #3 |
profesionalac
Qualified
|
a lol
__________________
I, blackshtef |
12. 10. 2009. | #4 |
dinosaurus
Master
Datum učlanjenja: 29.12.2005
Lokacija: Nova Engleska
Poruke: 636
Hvala: 79
263 "Hvala" u 66 poruka
|
|
12. 10. 2009. | #5 |
Goran Pilipović
Sir Write-a-Lot
|
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.
__________________
Goran Pilipović a.k.a. Ugly Fingers Bradley f.k.a. bluesman I don't always know what I'm talking about but I know I'm right! |
"Hvala" bluesman za poruku: |
12. 10. 2009. | #6 |
dinosaurus
Master
Datum učlanjenja: 29.12.2005
Lokacija: Nova Engleska
Poruke: 636
Hvala: 79
263 "Hvala" u 66 poruka
|
Нисам сигуран да се слажем. Кад се промени код, често се заборави да се промени и коментар па више штете него користи. Мада, јесте мало предугачко и напорно за читање
|
12. 10. 2009. | #7 |
Goran Pilipović
Sir Write-a-Lot
|
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?
__________________
Goran Pilipović a.k.a. Ugly Fingers Bradley f.k.a. bluesman I don't always know what I'm talking about but I know I'm right! |
12. 10. 2009. | #8 |
član
Certified
Datum učlanjenja: 27.11.2007
Poruke: 71
Hvala: 10
12 "Hvala" u 11 poruka
|
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.
Poslednja izmena od holodoc : 12. 10. 2009. u 18:32. |
12. 10. 2009. | #9 |
dinosaurus
Master
Datum učlanjenja: 29.12.2005
Lokacija: Nova Engleska
Poruke: 636
Hvala: 79
263 "Hvala" u 66 poruka
|
У ствари мислим да итекако има смисла променити име функције ако се промени оно што та функција ради.
|
12. 10. 2009. | #10 |
Goran Pilipović
Sir Write-a-Lot
|
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.
__________________
Goran Pilipović a.k.a. Ugly Fingers Bradley f.k.a. bluesman I don't always know what I'm talking about but I know I'm right! |
|
|
Slične teme | ||||
Tema | Početna poruka teme | Forum | Odgovori | Poslednja poruka |
Treba mi secondary DNS | misk0 | Web aplikacije, web servisi i software | 1 | 18. 06. 2009. 20:47 |
Treba nam Robocop :) | bluesman | Opušteno | 3 | 17. 12. 2007. 18:21 |
SQL injection: Sta sve treba da zastitim? | [nq] | SQL baze podataka - Sponzor: Baze-Podataka.net | 16 | 27. 04. 2007. 08:47 |
API dokumentacija za razne jezike, frameworke i biblioteke koda | kaizen | Linkovi | 2 | 03. 11. 2006. 18:00 |