U++ framework: Coffee corner » do users like commented code or not commented?

Home » Community » Coffee corner » do users like commented code or not commented?

Show: Today's Messages :: Polls :: Message Navigator
E-mail to friend

do users like commented code or not commented? [message #1119]

Mon, 20 February 2006 22:27

fudadmin
Messages: 1324
Registered: November 2005
Location: Kaunas, Lithuania

Ultimate Contributor
Administrator

Do users like commented code or not commented[ 18 votes ]
1.	users like commented code	16 / 89%
2.	users like not commented code	2 / 11%

No Message Body

Report message to a moderator

Re: do users like commented code or not commented? [message #1122 is a reply to message #1119]

Mon, 20 February 2006 22:36

mirek
Messages: 14291
Registered: November 2005

Ultimate Member

Please, add "documented/commented outside the code" option Smile

Mirek

Report message to a moderator

Re: do users like commented code or not commented? [message #1124 is a reply to message #1119]

Mon, 20 February 2006 22:57

zsolt
Messages: 705
Registered: December 2005
Location: Budapest, Hungary

Contributor

I like commented headers files (doxygen format).

drawbacks:
- it slows down compilation
- doc changes need code changes

advantage:
- simple to generate (doxygen)
- simple to maintain on API changes

Report message to a moderator

Re: do users like commented code or not commented? [message #1125 is a reply to message #1122]

Mon, 20 February 2006 23:03

fudadmin
Messages: 1324
Registered: November 2005
Location: Kaunas, Lithuania

Ultimate Contributor
Administrator

luzr wrote on Mon, 20 February 2006 16:36

Please, add "documented/commented outside the code" option Smile

Mirek

the question is about comments inside the code. Smile

Report message to a moderator

Re: do users like commented code or not commented? [message #1537 is a reply to message #1125]

Wed, 08 March 2006 12:04

hojtsy
Messages: 241
Registered: January 2006
Location: Budapest, Hungary

Experienced Member

I would like to add that descriptivenes of function and variable names could also be improved. This would decrease the amount of comments needed to understand the code, but they would still be needed.

Report message to a moderator

Re: do users like commented code or not commented? [message #1558 is a reply to message #1537]

Wed, 08 March 2006 22:20

mirek
Messages: 14291
Registered: November 2005

Ultimate Member

hojtsy wrote on Wed, 08 March 2006 06:04

I would like to add that descriptivenes of function and variable names could also be improved.

Well, I cannot promise to fix everything nor soon, but eventually you (and Arius) should put together a list of "bad" names.

It would break 20MB of my commercial codebase, but I am ready to go through that - if there is a really good reason....

Mirek

Report message to a moderator

Re: do users like commented code or not commented? [message #1560 is a reply to message #1558]

Wed, 08 March 2006 22:25

mirek
Messages: 14291
Registered: November 2005

Ultimate Member

...as for comments in the code...

...well, please let's defer this theme until Topic++ is finished and finaly integrated with class browser. I believe that my final vision is very nice and innovative.

Mirek

Report message to a moderator

Re: do users like commented code or not commented? [message #1563 is a reply to message #1558]

Wed, 08 March 2006 23:30

fudadmin
Messages: 1324
Registered: November 2005
Location: Kaunas, Lithuania

Ultimate Contributor
Administrator

luzr wrote on Wed, 08 March 2006 21:20

hojtsy wrote on Wed, 08 March 2006 06:04

I would like to add that descriptivenes of function and variable names could also be improved.

Shall we better start a new thread of topics in "Documentation" category where everyone, not happy with some namings, expands the lists by editing own posts?
And then we compare them?

Report message to a moderator