Pisanie kodu - zasady -_o

  6 posts   Feedicon  
Replies: 5 - Last Post: November 10, 2010 21:07
by: kingpig
« Older Topic » Newer Topic
showing 1 - 6 of 6
 
Posted: April 24, 2010 12:04 by kingpig
Wątek o dość wąskiej tematyce jaką jest redagowanie kodu.

Musimy trzymać się pewnych zasad, aby kod był dość jednolity i wszytkim przyjemnie się go czytało (oczywiście nikomu łba nie urwie, jeśli tych przepisów nie będzie się zawsze i wszędzie trzymał). Wszystko do przedyskutowania.

Moje sugestie:
  • kod piszemy w języku angielskim - tj. nazwy zmiennych, funkcji i ... komentarze (nie możemy ograniczać możliwości zrozumienia kodu dla kogoś, tylko dlatego, że on/ona does not speak in polish language
  • powstrzymujmy się od osobistego stylu nazywania zmiennych oraz pisania zbędnych komentarzy - także żadnych lol czy EPIC FAIL!!!! Smile
 
Posted: April 25, 2010 18:21 by miszaa
a potem bedzie takie coś Wink

napewno musimy robic którki badz dluzszy opis kazdej funkcji (co pobiera, co zwraca) w pliku naglowkowym + jak jej uzywac

wlasciwie jesli chodzi o male funkcje i zmienne lokalne to nie widze powodu by ich nie nazywac jakos dziwnie typu "dupa1" itp, moze to nie jest zbyt profesjonalne ale czy napewno sa jakies wielkie przeciwskazania co do tego?

a zbedne komentarze czesto sa naprawde ciekawa lektura np:

/**
* For the brave souls who get this far: You are the chosen ones,
* the valiant knights of programming who toil away, without rest,
* fixing our most awful code. To you, true saviors, kings of men,
* I say this: never gonna give you up, never gonna let you down,
* never gonna run around and desert you. Never gonna make you cry,
* never gonna say goodbye. Never gonna tell a lie and hurt you.
*/



lub:

//
// Dear maintainer:
//
// Once you are done trying to 'optimize' this routine,
// and have realized what a terrible mistake that was,
// please increment the following counter as a warning
// to the next guy:
//
// total_hours_wasted_here = 16
//

 
Posted: April 26, 2010 07:49 by Piotr Sobiech
Ja powiem tylko krótko:
http://wierzba.miks.uj.edu.pl/~gurgul/doxygen/

Głowna wartość trzeba zamieszczać PRZED funkcją, w formacie doxygen'a, a komentarze wewnątrz kodu pisać, tylko jeśli naprawde jest do tego potrzeba, tzn jeśli jest możliwość, że stosujemy jakis trick, o którym zapomnimy za tydzien, za dwa Tongue
 
Posted: April 26, 2010 16:46 by kingpig
Ale angielski ma być Tongue !
Ok, niech będą "dupy", ale kod ma być zrozumiały również dla koderów zza granicy.
 
Posted: October 15, 2010 18:09 by Hyuuga-sama
wybaczcie ze odgrzebuje temat-zombi, ale dopiero go zauwazylem i mnie zaciekawil :>

1st: komentarze wlasne sa na prawde ciekawa opcja, byle bez przesady (look @ linux kernel v1 source e.g.)
2nd: a komentarze w stylu:
// i dont know why and how it works, but it does
mozna wstawiac? ;p
 
Posted: November 10, 2010 21:07 by kingpig
A teraz wybacz Ty, bo dopiero zauważyłem nową odpowiedź w tym wątku Tongue (może będzie trzeba pomyśleć nad postawieniem własnego forum ...)

1 -> zgadzam się
2 -> myślę że taki programistyczny folklor będzie uprzyjemniał wspólną pracę Smile
showing 1 - 6 of 6
Replies: 5 - Last Post: November 10, 2010 21:07
by: kingpig
« Older Topic » Newer Topic
  • Mysql
  • Glassfish
  • Jruby
  • Rails
  • Nblogo
Terms of Use; Privacy Policy;
© 2010, Oracle Corporation and/or its affiliates
(revision 20120518.3c65429)
 
 
Close
loading
Please Confirm
Close