Logo Questions Linux Laravel Mysql Ubuntu Git Menu
HTML CSS JAVASCRIPT SQL PYTHON PHP BOOTSTRAP JAVA JQUERY R React Kotlin
 

Where can I find a good example of C# /// xml documentation comments in use? [closed]

Tags:

c#

documentation

I'm looking for some good examples of .NET XML-style source code comments and all the various tags available in use. Where can I find some good examples?

like image 571
Nosrama Avatar asked Aug 04 '09 16:08

Nosrama

People also ask

What is C programming with example?

C language is a system programming language because it can be used to do low-level programming (for example driver and kernel). It is generally used to create hardware devices, OS, drivers, kernels, etc. For example, Linux kernel is written in C. It can't be used for internet programming like Java, .Net, PHP, etc.

2 Answers

Here's a list of the recommended tags in Visual Studio, and here's a list of C# samples - many of which should have XML docs in them. One of the examples in the C# download is "XMLDoc" - and the readme from that starts with the following...

XML Documentation Sample

This sample shows how to use XML to document code.

like image 63
Scott Ivey Avatar answered Oct 03 '22 05:10

Scott Ivey

Helpful links:

  • XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files
  • Producing Professional MSDN-style Documentation with .NET and NDoc
  • XML Tags Used for Documentation Comments
like image 43
lance Avatar answered Oct 03 '22 03:10

lance
Sign in to Comment

Related questions

Async and await in MVC 4 Controller
S.O.L.I.D principles and compilation? [closed]
Why does VS warn me that typeof(T) is never the provided type in a generic method where the type parameter is restricted to implement T?
Shorthand Accessors and Mutators
Mongodb Convention packs
MongoDB .NET not generating _id on upsert
LINQ to Entities does not recognize the method 'System.Object GetValue(...)'
Decimal Parse Issue
JSON.NET is ignoring properties in types derived from System.Exception. Why?
Is it a good practice to add methods to the POCOs or to create separate class to update the values of the POCOs?
Stack and Queue enumeration order
External json vulnerable because of Json.Net TypeNameHandling auto?
Convert from HttpResponseMessage to IActionResult in .NET Core
Use both AddDbContextFactory() and AddDbContext() extension methods in the same project
Environment constants
Which is better apply two conditions in nested If or using single with And? [closed]
Embedding a DOS console in a windows form
C# Reflection : Finding Attributes on a Member Field
Dependency Injection and Class Inheritance
Reading data from an open HTTP stream

Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!