Ce limba folositi pentru a comenta codul ?

Acest forum este dedicat intrebarilor de programare care nu-si au locul in unul din celelalte forumuri

[POLL] Ce limba folositi pentru a insera comentarii in cod ?

1. Romana
2
12%
2. Engleza
15
88%
3. Alta limba
0
No votes
4. Scriu cod atat de clar incat n-are nevoie de comentarii (:))
0
No votes
 
Total votes: 17

nmg
Junior
Junior
Posts: 43
Joined: 12 Jul 2007, 07:36

Ce limba folositi pentru a comenta codul ?

Post by nmg » 02 Aug 2007, 12:30

Intrebarea se refera la limba preferata de dvs. pentru a introduce comentariile in cod. Eu prefer engleza pentru ca nu mai trebuie sa-mi storc creierii pentru a traduce cuvinte care au intrat deja in vocabularul uzual.



User avatar
Marius Bancila
Fondator
Fondator
Posts: 2344
Joined: 11 Jul 2007, 11:45
Judet: Timiş
Location: Timisoara
Contact:

Re: Ce limba folositi pentru a comenta codul ?

Post by Marius Bancila » 02 Aug 2007, 13:32

Pai la lucru trebuie sa le sciu in Engleza pentru a le putea intelege si colegii din Germania. Inainte de aia trebuiau sa fie intelese de canadieni. Asa ca m-am obisnuit de mult sa le scriu in engleza. Iar cand scriu ceva ce nu mai trebe inteles tot de altii, tot in engleza scriu. :mrgreen:
Marius Bancila
Fondator Codexpert, Microsoft MVP VC++
Site personal | Blog

User avatar
Ovidiu Cucu
Fondator
Fondator
Posts: 3778
Joined: 11 Jul 2007, 16:10
Judet: Iaşi
Location: Iasi
Contact:

Re: Ce limba folositi pentru a comenta codul ?

Post by Ovidiu Cucu » 02 Aug 2007, 14:59

Engleza, bineinteles.

Daca vedeti cumva prin forumuri comentarii de-ale mele gen...

Code: Select all

 ASSERT(FALSE); // nu trebuia sa ajungi aici, mai fraiere! 

... sa stiti ca alea nu-s luate dintr-un program real, ci sunt doar glume (de context) :) ;)

User avatar
Zanetti
Membru
Membru
Posts: 80
Joined: 20 Jul 2007, 08:57
Location: Tg.Mures

Re: Ce limba folositi pentru a comenta codul ?

Post by Zanetti » 02 Aug 2007, 21:24

Nu prea comentez codul dar cand o fac scriu in engleza. Suna mult mai bine decat in ro. :yes:
Ai fost facut DE Dumnezeu si PENTRU Dumnezeu - si pana vei intelege asta,viata ta nu va avea sens.

User avatar
naicul
Junior
Junior
Posts: 27
Joined: 21 Jul 2007, 16:08

Re: Ce limba folositi pentru a comenta codul ?

Post by naicul » 02 Aug 2007, 23:37

care e faza cu limba in care comentezi codul? am fost intrebat la un interviu treaba asta. am ramas perplex pentru cateva secunde apoi mi-am dat seama ca scriu comentearii in limba in care imi vine atunci. nu am nici o problema in a scrie comentarii nici in romana nici in engleza. dar nu mi se pare justificata curiozitatea asta. atata timp cat e intr-o limba pe care o inteleg eu si cei care, eventual, imi vor mai citi codul, totul ar trebui sa fie ok.
Engineer

User avatar
Ovidiu Cucu
Fondator
Fondator
Posts: 3778
Joined: 11 Jul 2007, 16:10
Judet: Iaşi
Location: Iasi
Contact:

Re: Ce limba folositi pentru a comenta codul ?

Post by Ovidiu Cucu » 03 Aug 2007, 01:41

naicul wrote:care e faza cu limba in care comentezi codul? am fost intrebat la un interviu treaba asta. am ramas perplex pentru cateva secunde apoi mi-am dat seama ca scriu comentearii in limba in care imi vine atunci. nu am nici o problema in a scrie comentarii nici in romana nici in engleza. dar nu mi se pare justificata curiozitatea asta. atata timp cat e intr-o limba pe care o inteleg eu si cei care, eventual, imi vor mai citi codul, totul ar trebui sa fie ok.
Hmmm... cred ca eu m-as scarpina putin dupa cap daca as gasi in cod comentarii de genul

Code: Select all

 // funcţie de mânuire a roţii şoarecelui... 


:thumbdown:

[off-topic] La inteviu se intreaba vrute si nevrute, incluzand si multe tampenii (gen "Fumezi?", "Nu", "De ce?" :D).
Nu trebuie neaparat sa fii si sincer. Spui ca ei si faci ca tine... ;)


Intr-o firma in care se mai si programeaza, nu doar se joaca darts pe diagrame gantt, rareori are timp cineva sa citeasca comentariile (doar cu scopul de a vedea cum sunt scrise).
Dar totusi, e bine de facut un mic efort si de pus din teava comenteriile in engleza.
Cand scrii numai pentru tine treaba ta... Se poate merge mai departe cu chestii de genul

Code: Select all

#define daca         if              
#define fa           do
#define DamiDreptunghiulFerestrei   GetWindowRect
Iar veni vreunuia dupa aia mai usor? :D

In incheiere n-as vrea sa enumar aici maximele si cugetarile rostite de colegi de-ai mei nevoiti sa aiba de-a face cu surse scrise si comentate de colaboratori de-ai nostri, sa zicem, de limba germana.
Doar...
Ce tie nu-ti place, altuia nu-i face!

nmg
Junior
Junior
Posts: 43
Joined: 12 Jul 2007, 07:36

Re: Ce limba folositi pentru a comenta codul ?

Post by nmg » 03 Aug 2007, 07:10

naicul wrote:care e faza cu limba in care comentezi codul? am fost intrebat la un interviu treaba asta. am ramas perplex pentru cateva secunde apoi mi-am dat seama ca scriu comentearii in limba in care imi vine atunci. nu am nici o problema in a scrie comentarii nici in romana nici in engleza. dar nu mi se pare justificata curiozitatea asta. atata timp cat e intr-o limba pe care o inteleg eu si cei care, eventual, imi vor mai citi codul, totul ar trebui sa fie ok.

Chestionarul are scop pur informativ. De ce nu ti se pare justificata curiozitatea asta ?

User avatar
naicul
Junior
Junior
Posts: 27
Joined: 21 Jul 2007, 16:08

Re: Ce limba folositi pentru a comenta codul ?

Post by naicul » 03 Aug 2007, 14:48

nmg wrote:
naicul wrote:care e faza cu limba in care comentezi codul? am fost intrebat la un interviu treaba asta. am ramas perplex pentru cateva secunde apoi mi-am dat seama ca scriu comentearii in limba in care imi vine atunci. nu am nici o problema in a scrie comentarii nici in romana nici in engleza. dar nu mi se pare justificata curiozitatea asta. atata timp cat e intr-o limba pe care o inteleg eu si cei care, eventual, imi vor mai citi codul, totul ar trebui sa fie ok.

Chestionarul are scop pur informativ. De ce nu ti se pare justificata curiozitatea asta ?
am explicat: e important ca eu si cel care, eventual, lucreaza cu codul meu sa inteleaga ce am scris. mai important e ce comentezi (sau daca comentezi), mai limba in care scrii comentariul (bineinteles, daca respecta prezumtia ca cei care mai lucreaza cu acel cod stiu limba respectiva).
Engineer

User avatar
Ovidiu Cucu
Fondator
Fondator
Posts: 3778
Joined: 11 Jul 2007, 16:10
Judet: Iaşi
Location: Iasi
Contact:

Re: Ce limba folositi pentru a comenta codul ?

Post by Ovidiu Cucu » 04 Aug 2007, 09:56

Exista o concepitie generala in randul tinerilor programatori ca e arhisuficient ca o bucata cod sa-si faca bine treaba.
Nu mai conteaza si cum e scrisa.
Problema e ca la un moment dat trebuie oaresce schimbari, adaugiri, sau chiar se ajunge la concluzia ca acel cod nu face deloc bine ceea ce face. Se intimpla, si inca foarte des.
De obicei "ia-l pe tanar de unde nu-i!" (nu, nu suna la informatii la Redmond sau la Toronto ca n-ai sa dai de el iar daca e doar la munte / la mare fii sigur ca si-a inchis celularul :))
Cade deci... cade magareatza pe un alt nenorocit, care trebuie inainte sa se scarpine dupa cap mult si bine sa-si dea seama ce-i prin cod inainte de a modifica/adauga propriuzis o linie-doua.
Bine, cineva va zice ca salvarea este o buna documentatie de design si implementare... Asta e intradevar minunat si cade bine la un audit. E minunat teorectic, pentru ca practic... (ma rog... nu mai discut).

Una dintre modalitatile simple si la indemana tuturor de a scrie "cod frumos si pe inteles" este de a pune comentarii.
Nu pentru ca asa vrea politica firmei, nu pentru ca sa faci fericita o scula de analiza de cod, nu pentru ca asa vrea "tembleul" ala de manager de proiect ci pentru ca asta poate ajuta chiar si pentru autorul insusi...
Multi poate nu stiu cat de fericit poti intr-un moment cand falfaie meilurile, zbarnaie telefoanele, s-a umplut pagina cu raportare de baguri, crapa maseaua dar... gasesti un mic comentariu "frumos" si la obiect, exact acolo unde trebuie.

Si pentru ca problema initiala era de fapt limba in care se scriu comentariile.
Din moment ce documentatia pe care o folosim (pentru C++, programare Windows, .NET, whatever) este in engleza, nu vad nici o dificultate pentru orice programator sa scrie si comentariile in engleza, pentru consistenta, pentru a fi intelese de oricine in lumea asta, pentru a fi toata lumea multumita, pentru orice alt motiv vrei...

Poate doare un pic mana la inceput, dar mai rau e daca te doare capul dupa aia. ;)

Ovidiu

PS. Nu am pus niciodata o astfel de intrebare la interviu, neavand timp de asa ceva si trebuind sa ma axez in special pe probleme strict tehnice de limbaj de programare. Insa altii, prefera alt stil de abordare mai general si mai putin tehnic, iar in cazul alora nu mi se pare nimic iesit din comun sa intrebe "ce limba folosesti pentru comentarii in cod?". E chiar prea tehnic... :) Parerea mea.

User avatar
naicul
Junior
Junior
Posts: 27
Joined: 21 Jul 2007, 16:08

Re: Ce limba folositi pentru a comenta codul ?

Post by naicul » 04 Aug 2007, 11:52

Da, Ovidiu, cred ca toata lumea e de acord ca trebuie comentat codul. Ai tinut o lectie despre "de ce e bine sa scrii comentarii" degeaba.
Engineer

User avatar
Ovidiu Cucu
Fondator
Fondator
Posts: 3778
Joined: 11 Jul 2007, 16:10
Judet: Iaşi
Location: Iasi
Contact:

Re: Ce limba folositi pentru a comenta codul ?

Post by Ovidiu Cucu » 04 Aug 2007, 21:04

Hmm... n-am tinut o "lectie" despre ceva unanim acceptat ci doar am increcat o pledoarie pentru ceva care in general, in practica, nu se respecta (de aceea da, probabil ca a fost "degeaba"... :D ;)).

User avatar
Hannibal
Membru
Membru
Posts: 104
Joined: 30 Jul 2007, 15:18
Location: Bucuresti
Contact:

Re: Ce limba folositi pentru a comenta codul ?

Post by Hannibal » 06 Aug 2007, 11:44

Da Ovidiule, dar am vazut cometarii de genul

Code: Select all

       // paint background
        PaintBackground(hDC, rcClient);

	hvString caption;
	GetWindowText(caption);

        // paint caption
	if (GetBordersSize().top > 0 && caption.GetLength() > 0)
		PaintCaption(hDC, rcClient, caption, DT_CENTER | DT_SINGLELINE | DT_VCENTER);
si e chiar stupid... adica atunci cand operatia e clar indusa de numele procedurii nu este inutil sa sa comentezi?
si pe de alta parte codul asta il lasa in pace... pentru ca e foarte clar :twisted: :

Code: Select all

BOOL CAS(volatile pointer_t*dest,volatile pointer_t comp,pointer_t val)
{
	unsigned result=0;
	__asm
	{
		mov esi,dest;
		mov eax,dword ptr comp;
		mov edx,dword ptr comp+4;
		mov ebx,dword ptr val;
		mov ecx,dword ptr val+4;
		lock cmpxchg8b  [esi];
		setz byte ptr result;
	}
	return result;
}
PS. arata demential comentariile in japoneza sau coreana... inutile dar frumoase

User avatar
Marius Bancila
Fondator
Fondator
Posts: 2344
Joined: 11 Jul 2007, 11:45
Judet: Timiş
Location: Timisoara
Contact:

Re: Ce limba folositi pentru a comenta codul ?

Post by Marius Bancila » 06 Aug 2007, 11:57

Scriam pe blog-ul meu acum vreom 2 luni de site-ul asta: http://mindprod.com/jgloss/unmain.html. Probabil ca unele tehnici dinastea sunt luate de acolo. :)
Marius Bancila
Fondator Codexpert, Microsoft MVP VC++
Site personal | Blog

User avatar
Ovidiu Cucu
Fondator
Fondator
Posts: 3778
Joined: 11 Jul 2007, 16:10
Judet: Iaşi
Location: Iasi
Contact:

Re: Ce limba folositi pentru a comenta codul ?

Post by Ovidiu Cucu » 06 Aug 2007, 12:59

Hannibal wrote:Da Ovidiule, dar am vazut cometarii de genul

Code: Select all

       // paint background
        PaintBackground(hDC, rcClient);
si e chiar stupid... adica atunci cand operatia e clar indusa de numele procedurii nu este inutil sa sa comentezi?
Eh... alea n-ar fi chiar atat de stupide.
Chiar si numai pentru faptul ca imi apar in editor colorate diferit ma ajuta sa vad mai rep'de ce-i acolo.

Pot sa-ti dau eu exemple un pic mai bune de comentarii duse la "extrem"

Code: Select all

///////////////////////////////////////////////////////////// 
// Function:   CFoo::CFoo()
// Purpose:    Constructor
// Parameters: None                              
// Returns:    None                                        
// Remarks:    Please, add object initialization code here!
/////////////////////////////////////////////////////////////

// prea multe reguli si sedinte de code inspection pot transforma pe unii copilasi in scule de scris comentarii. :D

albertinix
Junior
Junior
Posts: 6
Joined: 20 Jul 2007, 09:58

Re: Ce limba folositi pentru a comenta codul ?

Post by albertinix » 06 Aug 2007, 14:56

Ovidiu Cucu wrote:

Code: Select all

///////////////////////////////////////////////////////////// 
// Function:   CFoo::CFoo()
// Purpose:    Constructor
// Parameters: None                              
// Returns:    None                                        
// Remarks:    Please, add object initialization code here!
/////////////////////////////////////////////////////////////
Sunt perfect de acord cu Ovidiu aici. Comentariile sunt bune. Chiar daca la prima vedere par in plus, uneori chiar duse "la extrem". Noi folosim in toate sursele noastre comentarii de genul celui de mai sus - uneori chiar mai explicite. Si acestea fiind doar comentariile de inceput. Mai urmeaza si cele din corpul functiei.
Comentariile nu strica. Niciodata. Indiferent cat de bine stii acum codul, chiar daca tu si nu altcineva te uiti peste el dupa o perioada de 3 luni - n-ai sa mai stii mare lucru. Si atunci comentariile vin f bine.
Cat despre limba in care sunt scrise - aici e vorba de conventie. Insa cred ca - indiferent care ar fi aceasta conventie - nu e DELOC bine sa scrii comentarii in mai multe limbi. Personal eu as recomanda peste tot engleza. Motivele sunt multiple si n-am sa le enumar. Cred ca ar trebui sa folosesti o limba de circulatie restransa (gen romana) - doar daca esti absolut sigur ca toate sursele vor fi citite la un moment dat de vorbitori ai aceleiasi limbi. Si poate nici atunci.

Post Reply