Click here to Skip to main content
14,601,286 members

Work Issues

 
GeneralRe: How to write a programming language in Hindi? Pin
INDtanay23-Nov-17 6:01
MemberINDtanay23-Nov-17 6:01 
GeneralRe: How to write a programming language in Hindi? Pin
Member 1349103927-Nov-17 17:07
MemberMember 1349103927-Nov-17 17:07 
QuestionWorking with software houses / SDLC expertise Pin
JohnLBevan4-Oct-17 0:30
professionalJohnLBevan4-Oct-17 0:30 
SuggestionDrop Down Issue Pin
Member 1332500523-Jul-17 21:04
MemberMember 1332500523-Jul-17 21:04 
GeneralRe: Drop Down Issue Pin
Richard Deeming24-Jul-17 8:07
mveRichard Deeming24-Jul-17 8:07 
QuestionOf Code and Comments Pin
I.explore.code30-Jun-17 8:19
MemberI.explore.code30-Jun-17 8:19 
AnswerRe: Of Code and Comments Pin
David A. Gray30-Jun-17 9:22
MemberDavid A. Gray30-Jun-17 9:22 
GeneralRe: Of Code and Comments Pin
I.explore.code30-Jun-17 10:19
MemberI.explore.code30-Jun-17 10:19 
Yeah I was referring to the XML comments and specifically in C# and I appreciate your point that not everything can be communicated by the code sufficiently clearly for e.g. a complex algorithm implementation that might require some additional prose to describe the whats, the whys and the hows. Perfectly acceptable.

However, I don't agree with putting even XML comments everywhere even when the code is self-evident. If I as a developer don't write clean enough code that reveals its intentions and purposes then how can I be relied upon to write clear concise comments? At best/worst I might be lying about the code which probably will become clear in code reviews but code reviews are about the code, not comments. Code executes, comments don't. If I am going to spend effort anyway, I'd rather use it to refactor code, not comments. Not to mention maintaining code itself is a major task add to that the burden of maintaining the comments and the whole thing becomes a real drag on programmer productivity. I much rather spend that time on refactoring and testing the code to make it as clear and provable as possible.

Plus, compiler provides little to no support for comments (apart from cosmetic colour coding) and any time I change a method signature or the purpose, comments don't auto update because they can't read my mind! Now, office politics perhaps may be a reason why someone might get forced to write comments despite their better judgement, which I think might be at play in my case.

On the change log, I believe check-in comments are the place to put your reasoning to have changed any code. This way I can look at the comments in source control and if I feel like I can just do a diff to see what changed and whether or not it correlates to the comment. Ultimately, its about the developer discipline and I much rather use it to write meaningful and clean code, test cases and check-in comments rather than bunging everything in the source code file that contains everything but meaningful code. Its like my grandma used to say, "Everything in its place and a place for everything!".

Thanks for your input anyway. Appreciated! Smile | :)
GeneralRe: Of Code and Comments Pin
David A. Gray30-Jun-17 10:33
MemberDavid A. Gray30-Jun-17 10:33 
GeneralRe: Of Code and Comments Pin
I.explore.code30-Jun-17 12:55
MemberI.explore.code30-Jun-17 12:55 
GeneralRe: Of Code and Comments Pin
David A. Gray5-Jul-17 16:02
MemberDavid A. Gray5-Jul-17 16:02 
GeneralRe: Of Code and Comments Pin
I.explore.code14-Jul-17 13:13
MemberI.explore.code14-Jul-17 13:13 
GeneralRe: Of Code and Comments Pin
Davie2124019-Feb-18 10:43
MemberDavie2124019-Feb-18 10:43 
AnswerRe: Of Code and Comments Pin
Foothill30-Jun-17 9:59
professionalFoothill30-Jun-17 9:59 
GeneralRe: Of Code and Comments Pin
David A. Gray30-Jun-17 10:30
MemberDavid A. Gray30-Jun-17 10:30 
AnswerRe: Of Code and Comments Pin
Eddy Vluggen1-Jul-17 0:21
professionalEddy Vluggen1-Jul-17 0:21 
GeneralRe: Of Code and Comments Pin
I.explore.code1-Jul-17 6:50
MemberI.explore.code1-Jul-17 6:50 
GeneralRe: Of Code and Comments Pin
Eddy Vluggen1-Jul-17 7:34
professionalEddy Vluggen1-Jul-17 7:34 
GeneralRe: Of Code and Comments Pin
I.explore.code1-Jul-17 9:14
MemberI.explore.code1-Jul-17 9:14 
GeneralRe: Of Code and Comments Pin
Eddy Vluggen1-Jul-17 10:05
professionalEddy Vluggen1-Jul-17 10:05 
GeneralRe: Of Code and Comments Pin
I.explore.code1-Jul-17 13:33
MemberI.explore.code1-Jul-17 13:33 
GeneralRe: Of Code and Comments Pin
Eddy Vluggen1-Jul-17 23:27
professionalEddy Vluggen1-Jul-17 23:27 
GeneralRe: Of Code and Comments Pin
I.explore.code2-Jul-17 1:01
MemberI.explore.code2-Jul-17 1:01 
GeneralRe: Of Code and Comments Pin
maze327-Apr-18 4:52
professionalmaze327-Apr-18 4:52 
AnswerRe: Of Code and Comments Pin
imagiro4-Jul-17 21:51
Memberimagiro4-Jul-17 21:51 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.