Take Advantage of XML Comments: Listing 2

<?xml version="1.0"?>
<doc>
<assembly>
<name>
XMLComments_VB
</name>
</assembly>
<members>
<member name="M:XMLComments_VB.VB_Class1.TheAnswer">
	<summary>
 The Ultimate Answer to the Ultimate Question of Life, the Universe, and Everything
 </summary>
	<returns>From The Hitchhiker's Guide to the Galaxy by Douglas Adams</returns>
	<remarks>Computed here considerably faster than that in the book</remarks>
</member><member name="M:XMLComments_VB.VB_Class1.FinalGoodbye">
	<summary>
 So Long, and Thanks for All the Fish
 </summary>
	<SpokenBy>Dolphins, the second most intelligent species on Earth after mice, just before they all departed the Earth</SpokenBy>
	<remarks>Title of the fourth book of the Hitchhiker's Guide to the Galaxy trilogy by Douglas Adams</remarks>
</member><member name="T:XMLComments_VB.VB_Class1">
	<summary>
 Class1 performs some useful capability
 </summary>
	<Developer email="[email protected]">Joe Kunk</Developer>
	<remarks>For ON VB article</remarks>
</member><member name="T:XMLComments_VB.VB_Class2">
	<summary>
 Summary for VB_Class2
 <activity>
			<CreatedBy>Samatha Smith</CreatedBy>
			<CreatedDate>07/01/2011</CreatedDate>
			<Description>Description for VB_Class2</Description>
			<Developer>Joe Kunk</Developer>
			<HelpDeskID>1234</HelpDeskID>
			<ModifiedBy>Jeff Jefferson</ModifiedBy>
			<ModifiedDate>07/03/2011</ModifiedDate>
		</activity>
	</summary>
	<remarks>Remarks for VB_Class2
    <para/>CreatedBy: Samatha Smith
    <para/>CreatedDate: 07/01/2011
    <para/>Description: Description for VB_Class2
    <para/>Developer: Joe Kunk
    <para/>HelpDeskID: 1234
    <para/>ModifiedBy: Jeff Jefferson
    <para/>ModifiedDate: 07/03/2011
</remarks>
</member><member name="P:XMLComments_VB.My.Resources.Resources.ResourceManager">
	<summary>
  Returns the cached ResourceManager instance used by this class.
</summary>
</member><member name="P:XMLComments_VB.My.Resources.Resources.Culture">
	<summary>
  Overrides the current thread's CurrentUICulture property for all
  resource lookups using this strongly typed resource class.
</summary>
</member><member name="T:XMLComments_VB.My.Resources.Resources">
	<summary>
  A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
</members>
</doc>

About the Author

Joe Kunk is a Microsoft MVP in Visual Basic, three-time president of the Greater Lansing User Group for .NET, and developer for Dart Container Corporation of Mason, Michigan. He's been developing software for over 30 years and has worked in the education, government, financial and manufacturing industries. Kunk's co-authored the book "Professional DevExpress ASP.NET Controls" (Wrox Programmer to Programmer, 2009). He can be reached via email at [email protected].

comments powered by Disqus

Featured

  • Compare New GitHub Copilot Free Plan for Visual Studio/VS Code to Paid Plans

    The free plan restricts the number of completions, chat requests and access to AI models, being suitable for occasional users and small projects.

  • Diving Deep into .NET MAUI

    Ever since someone figured out that fiddling bits results in source code, developers have sought one codebase for all types of apps on all platforms, with Microsoft's latest attempt to further that effort being .NET MAUI.

  • Copilot AI Boosts Abound in New VS Code v1.96

    Microsoft improved on its new "Copilot Edit" functionality in the latest release of Visual Studio Code, v1.96, its open-source based code editor that has become the most popular in the world according to many surveys.

  • AdaBoost Regression Using C#

    Dr. James McCaffrey from Microsoft Research presents a complete end-to-end demonstration of the AdaBoost.R2 algorithm for regression problems (where the goal is to predict a single numeric value). The implementation follows the original source research paper closely, so you can use it as a guide for customization for specific scenarios.

  • Versioning and Documenting ASP.NET Core Services

    Building an API with ASP.NET Core is only half the job. If your API is going to live more than one release cycle, you're going to need to version it. If you have other people building clients for it, you're going to need to document it.

Subscribe on YouTube