Tagged Questions
37
votes
9answers
2k views
Code maintenance: To add comments in code or to just leave it to the version control?
We have been asked to add comments with start tags, end tags, description, solution etc for each change that we make to the code as part of fixing a bug / implementing a CR.
My concern is, does this ...
3
votes
4answers
305 views
How to discriminate commented code and documentation comments
After using version control tools, it is no longer necessary to comment out old code.
However, some team members still comment out old code. Therefore, I want to clean them up.
I want to mark ...
9
votes
11answers
505 views
What should I put in comments while commiting to the Source Control?
I am a lone developer and maintain a SVN server for source control. So far, I haven't followed anything specific while committing my changes.
I was just reviewing my previous commits, and couldn't ...
4
votes
4answers
160 views
proper comments for source control log [duplicate]
Possible Duplicate:
What is your typical source control commit comment?
What are suitable comments to put in the source control log?
To me this seems a similar problem (but possibly more ...
13
votes
4answers
476 views
Is there justification for leaving conflict markers in checked-in code?
Consider conflict markers. i.e.:
<<<<<<< branch
blah blah this
=======
blah blah that
>>>>>>> HEAD
In the particular case which has motivated me to post ...
70
votes
22answers
3k views
How do I convince my fellow devs to WANT to add comments to source code commits?
I know that Subversion (what we're using at work) can be configured to require comments on commits, however I'm not in a position of power to simply turn this on. I know that my reason for commenting ...
24
votes
18answers
1k views
What is your typical source control commit comment? [closed]
What details, if any, do you record in your comments when committing to source control? Do you tend to commit every tiny change or only mega updates to your code? Do you have any system or style guide ...
