XML Comment Checker free download, XML Comment Checker download on software download

XML Comment Checker is an application that will check the XML documentation for a .Net assembly for omissions. It offers a more comprehensive checking than the C# compiler itself, and is ideal for when you wish to check your comments before compiling them into real documentation, e.g using Microsoft Sandcastle. Like the C# compiler, XML Comment Checker will check whether all publicly visible types and members (i.e. public types and public or protected members) have XML comments. It can be used to perform this check for Visual Basic code, as the Visual Basic compiler does not provide these checks. Additionally, XML Comment checker offers the following features not offered by either the C# or VB compilers: -Check for required sections. You can ensure sections such as or are present. Which sections are required can be configured per member type by altering the CommentChecker.exe.config file. By Default, XML Comment Checker will check for the and sections on classes and structures, the and sections on properties, and the section for everything else. See the CommentChecker.exe.config file for more Details. -Check for the presence of and elements. XML Comment checker will check whether all parameters of methods and all type parameters of generic types or methods are documented. -Check for the presence of elements. XML Comment Checker will warn if a method with a non-void return type does not have a element. -Check for empty sections. Optionally, XML Comment Checker will warn if any of the required sections or elements are present, but empty. This is not enabled by default -Check for exceptions. XML Comment Checker will check for exception types used in a method body and will warn if they have no matching element.

XML Comment Checker Related Software