Unique way to add comment in vb and c# which will include added/edited date,purpose,and developer name

Question

1.00/5 (1 vote)

See more:

it's very simple question-
here somebody comment like

VB

1st format
'added on-06-12-2012
'By-xyz
'Remarks: For Cancel button click event.
or
2nd format
'Addedby-XYZ ON 06-12-2012 For Cancel button click event.

Private Sub BttnCancel_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles BttnCancel.Click
            ActionCancel()
            ActionClose()
End Sub

so i just want to know more format for comment.Bcoz this type of comment used by most people,so i want some diff for this.

Posted 10-Dec-12 20:22pm

StackQ

Updated 10-Dec-12 21:41pm

v3

Add a Solution

Comments

OriginalGriff 11-Dec-12 2:47am

This is not a good question - we cannot work out from that little what you are trying to do.
Remember that we can't see your screen, access your HDD, or read your mind.
Use the "Improve question" widget to edit your question and provide better information.

StackQ 11-Dec-12 3:41am

see my improve question and suggest me some more format to add comment.

BotCar 11-Dec-12 3:24am

This question is too open ended for the Q&A section. Try starting a discussion in one of the forums, such as the Lounge[^], Design and Architecture[^], or even Visual Basic[^].

StackQ 11-Dec-12 3:42am

see my improve question and suggest me some more format to add comment.

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

OriginalGriff · Answer 1 · 2012-12-10T21:49:00

This is too open ended - there is no standard for this kind of information, either a coder will have his own style, or there may be a company style. However, have a look at this: http://www.icsharpcode.net/technotes/commenting20020413.pdf[^] - it's on commenting generally and covers modification history.

BTW: Modification history should be a part of the XML comments you attach to your methods - or rather don't in the example you give. See here: http://msdn.microsoft.com/en-us/library/ms172652(v=vs.80).aspx[^]. It can make a big difference to use them as Intellisense can pick them up if nothing else!