Click here to Skip to main content
15,882,802 members
Please Sign up or sign in to vote.
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
Updated 10-Dec-12 21:41pm
v3
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

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!
 
Share this answer
 

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



CodeProject, 20 Bay Street, 11th Floor Toronto, Ontario, Canada M5J 2N8 +1 (416) 849-8900