SubMain - CodeIt.Right The First Time!

/Community

A Support Community for SubMain Products
 Home Products Services Download Purchase Support
in Search
 
Home Forums Blogs Tutorials Downloads
Welcome to SubMain Community Sign in | Join | Help

Custom commenting of a class

Last post 07-04-2009, 12:26 AM by Serge B.. 1 replies.
Sort Posts: Previous Next
  •  06-30-2009, 2:26 AM 817

    Custom commenting of a class

    Hi.

    I've been using Ghostdoc for commenting in a few C# courses and I really like the functionallity.

    I'm now reading a VB course and ghostdoc (I have v.2.5) seems to work fine here as well. The teacher of the course want the students to comment each class  like the following:

    'Name:ClassName.vb
    'Creator: My Name
    'Created: 2009-06-29
    'Revised: 2009-06-30

    Public Class  ClassName

          'code

    End Class

     

    This becomes a bit tedious when the numbers of files increase and I'm wondering if anyone here knows if and how Ghostdoc can do this for me, i.e. automatically writing the current class name, creation date and revision date etc., when commenting the Class so it becomes something similar to this:

     

    ''' <summary>
    ''' Name:ClassName.vb
    ''' Creator: My Name
    ''' Created: 2009-06-29
    ''' 'Revised: 2009-06-30
    ''' </summary>
    Public Class ClassName

     

    Note that i only want this on the Class not on the Methods and other things. Thank you in advance,

    Calle

     

     


    Calle Liedberg
  •  07-04-2009, 12:26 AM 824 in reply to 817

    Re: Custom commenting of a class

    Hi Calle,

    That is not something GhostDoc can do as it is aimed specifically at the XML Comments.

    In our CodeIt.Right product though one of the many rules we have is to verify that a file/class has header. The rule can automatically generate the headers based on the standard template we ship or uyou can customize the template in the Profile Editor.

    Thanks!


    Thank you,
    Serge Baranovsky
    http://submain.com - .NET Developer Tools  |  Microsoft VB MVP  |  http://vbcity.com - VB Developer Community
    » » (Static Code Analysis + Automatic Refactoring) / Painless Coding Guidelines = CodeIt.Right - http://submain.com/codeit.right
    » » C#/VB .NET Coding Guidelines - FREE 100+ page ebook (PDF) http://submain.com/guidelines
View as RSS news feed in XML
 
     
 
Home |  Products |  Services |  Download |  Purchase |  Support |  Community |  About Us |