Click here to Skip to main content
Rate this: bad
good
Please Sign up or sign in to vote.
See more: C# VB.NET
it's very simple question-
here somebody comment like
 
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
Edited 10-Dec-12 21:41pm
v3
Comments
OriginalGriff at 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.
01010RAJ at 11-Dec-12 3:41am
   
see my improve question and suggest me some more format to add comment.
TheOtherCPian at 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[^].
01010RAJ at 11-Dec-12 3:42am
   
see my improve question and suggest me some more format to add comment.

1 solution

Rate this: bad
good
Please Sign up or sign in to vote.

Solution 1

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!
  Permalink  

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

  Print Answers RSS
0 OriginalGriff 205
1 ProgramFOX 120
2 Richard MacCutchan 100
3 ChauhanAjay 100
4 kbrandwijk 90
0 Sergey Alexandrovich Kryukov 9,050
1 OriginalGriff 8,151
2 CPallini 2,613
3 Richard MacCutchan 2,221
4 Abhinav S 1,928


Advertise | Privacy | Mobile
Web04 | 2.8.140827.1 | Last Updated 11 Dec 2012
Copyright © CodeProject, 1999-2014
All Rights Reserved. Terms of Service
Layout: fixed | fluid

CodeProject, 503-250 Ferrand Drive Toronto Ontario, M3C 3G8 Canada +1 416-849-8900 x 100