info/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2025-08-05 06:17:36 +02:00
Code Issues Releases Wiki Activity

Fixes the spacing of comments in the English C# documentation

Browse Source
This commit is contained in:
Chris Zimmerman
2019-09-30 18:11:43 -04:00
parent dff76c7965
commit 3ade005c37
1 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
csharp.html.markdown
View File

@@ -18,16 +18,18 @@ C# is an elegant and type-safe object-oriented language that enables developers
```c# ```c#
// Single-line comments start with // // Single-line comments start with //
/* /*
Multi-line comments look like this Multi-line comments look like this
*/ */
/// <summary> /// <summary>
/// This is an XML documentation comment which can be used to generate external /// This is an XML documentation comment which can be used to generate external
/// documentation or provide context help within an IDE /// documentation or provide context help within an IDE
/// </summary> /// </summary>
/// <param name="firstParam">This is some parameter documentation for firstParam</param> /// <param name="firstParam">This is some parameter documentation for firstParam</param>
/// <returns>Information on the returned value of a function</returns> /// <returns>Information on the returned value of a function</returns>
//public void MethodOrClassOrOtherWithParsableHelp(string firstParam) {} public void MethodOrClassOrOtherWithParsableHelp(string firstParam) {}
// Specify the namespaces this source code will be using // Specify the namespaces this source code will be using
// The namespaces below are all part of the standard .NET Framework Class Library // The namespaces below are all part of the standard .NET Framework Class Library
@@ -373,7 +375,7 @@ on a new line! ""Wow!"", the masses cried";
Console.Read(); Console.Read();
} // End main method } // End main method
// CONSOLE ENTRY A console application must have a main method as an entry point // CONSOLE ENTRY - A console application must have a main method as an entry point
public static void Main(string[] args) public static void Main(string[] args)
{ {
OtherInterestingFeatures(); OtherInterestingFeatures();
@@ -1069,7 +1071,7 @@ on a new line! ""Wow!"", the masses cried";
{ {
private static bool LogException(Exception ex) private static bool LogException(Exception ex)
{ {
/* log exception somewhere */ // log exception somewhere
return false; return false;
} }
@@ -1117,12 +1119,12 @@ on a new line! ""Wow!"", the masses cried";
[Obsolete("Use NewMethod instead", false)] [Obsolete("Use NewMethod instead", false)]
public static void ObsoleteMethod() public static void ObsoleteMethod()
{ {
/* obsolete code */ // obsolete code
} }
public static void NewMethod() public static void NewMethod()
{ {
/* new code */ // new code
} }
public static void Main() public static void Main()