by Serge Baranovsky

New CodeIt.Right rule posted:

• Externally visible types and members should have XML comments (General)

This rule makes sure all Public and Protected members and types have XML documentation comment.

AutoCorrect option for this rule is 'Add XML comment template' which will add

(for VB)

    ''' <summary>
    '''     
    ''' </summary>
    ''' <value>
    '''     <para>
    '''         
    '''     </para>
    ''' </value>
    ''' <remarks>
    '''     
    ''' </remarks>

(for C#)

    /// <summary>
    ///     
    /// </summary>
    /// <value>
    ///     <para>
    ///         
    ///     </para>
    /// </value>
    /// <remarks>
    ///     
    /// </remarks>

(actual content of the template will depend of the code element the XML template are being added to).

This set of rules is distributed using the Rule AutoUpdate feature added into the Beta 2 of CodeIt.Right. Auto Update triggers in 15 minutes after you start Visual Studio. If you turned the feature off you can manually start the update wizard from the CodeIt.Right/Help & Support/Update Rules menu.

Don't forget to leave your feedback in the CodeIt.Right forum http://community.submain.com/forums/4/ShowForum.aspx

(Note: if you skip the custom profile update step in the Rules Update Wizard, you still can add new rules to your custom profile(s) using the Add Rule button in the Profile Editor - you will find recent rules by sorting the date column)

Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET