diff options
| author | Dean Becker <deanbecker7@gmail.com> | 2015-10-20 16:32:49 +0100 |
|---|---|---|
| committer | Dean Becker <deanbecker7@gmail.com> | 2015-10-20 16:32:49 +0100 |
| commit | e675c887fe27538805a2b8deddf3f3d37a653d7c (patch) | |
| tree | a573e10f4c2757f8a91c55eb835d04c88accdb4f /csharp.html.markdown | |
| parent | b354013dc9bcba5e76bd3cf720eae8af7d9eba89 (diff) | |
Expanded XML Doc example
Just an expansion of the XML documentation example, the <param> tag can be very useful in Visual Studio, especially.
Diffstat (limited to 'csharp.html.markdown')
| -rw-r--r-- | csharp.html.markdown | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/csharp.html.markdown b/csharp.html.markdown index dfdd98de..c844c479 100644 --- a/csharp.html.markdown +++ b/csharp.html.markdown @@ -24,7 +24,9 @@ Multi-line comments look like this /// This is an XML documentation comment which can be used to generate external /// documentation or provide context help within an IDE /// </summary> -//public void MethodOrClassOrOtherWithParsableHelp() {} +/// <param name="firstParam">This is some parameter documentation for firstParam</param> +/// <returns>Information on the returned value of a function</returns> +//public void MethodOrClassOrOtherWithParsableHelp(string firstParam) {} // Specify the namespaces this source code will be using // The namespaces below are all part of the standard .NET Framework Class Libary |