Coding standards - Revision history

Ubit: /* Formatting */

2026-03-19T18:51:08Z

‎Formatting

2026-03-19T18:47:13Z

‎use of var and new()

2025-10-07T21:54:38Z

2025-10-05T23:54:27Z

‎Logging

2025-10-05T23:51:17Z

‎Guidelines

2025-10-05T23:48:24Z

‎use of var and new()

2022-11-10T04:27:28Z

‎use of var and new()

2022-11-10T04:27:06Z

‎Logging

2022-11-10T04:13:26Z

‎Source Repository (SVN)

2012-03-04T02:52:19Z

Robot: Cosmetic changes

@@ Line 15: / Line 15: @@
 * We put curly brackets on separate lines and use 4 space tabs.
-* Tab themselves should be spaces, not actual hard tabs.
+* Tab themselves must be be 4 spaces, not actual hard tabs.
-* Use string instead of String when refering to the System.String type.
+* Use c# object type instead of Dotnet support class name, i.e. string, object, double etc. instead of String, Object, Double .
 === Naming ===

@@ Line 92: / Line 92: @@
      var a = new List<string>();
 //or
-     List<string> b = new(); // ok
+     List<string> b = new(); // preferred
      var c = mything(); // not ok. we cant see the type without looking for mything details.
 </pre>
 [[Category:Standards]]

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{Quicklinks}}
+{{Quicklinks|Coding_standards}}
 <br />
 == Guidelines ==

@@ Line 75: / Line 75: @@
 === Logging ===
-Each class should have their own logger which is declared private and is not inherited:
+Each class, when needed, should have their own logger which is declared private and is not inherited:
 <pre>

@@ Line 3: / Line 3: @@
 <br />
 == Guidelines ==
 We follow standard C# coding guidelines unless otherwise stated: [http://msdn.microsoft.com/en-us/library/czefa0ke.aspx]. Corrections to existing files to follow these standards are welcome.

← Older revision		Revision as of 23:48, 5 October 2025
Line 81:		Line 81:

	Only use var in a variable declaration when the type of the variable is clear on the right side		Only use var in a variable declaration when the type of the variable is clear on the right side
		+	Only use new(..) in a variable declaration when the type of the variable is clear on the left side

	<pre>		<pre>

@@ Line 80: / Line 80: @@
 === use of var and new()===
-Only use var in variables declaration when the type of the variable is clear on the right side
+Only use var in a variable declaration when the type of the variable is clear on the right side
 <pre>

@@ Line 76: / Line 76: @@
      private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+}
 </pre>
 [[Category:Standards]]

← Older revision		Revision as of 04:13, 10 November 2022
Line 5:		Line 5:

	We follow standard C# coding guidelines unless otherwise stated: [http://msdn.microsoft.com/en-us/library/czefa0ke.aspx]. Corrections to existing files to follow these standards are welcome.		We follow standard C# coding guidelines unless otherwise stated: [http://msdn.microsoft.com/en-us/library/czefa0ke.aspx]. Corrections to existing files to follow these standards are welcome.
−
−	~~=== Source Repository (SVN) ===~~
−
−	* For new files execute: svn propset svn:eol-style native <file path>

	=== Formatting ===		=== Formatting ===

@@ Line 2: / Line 2: @@
 {{Quicklinks}}
 <br />
-==Guidelines==
+== Guidelines ==
-We follow standard C# coding guidelines unless otherwise stated: [http://msdn.microsoft.com/en-us/library/czefa0ke.aspx].  Corrections to existing files to follow these standards are welcome.
+We follow standard C# coding guidelines unless otherwise stated: [http://msdn.microsoft.com/en-us/library/czefa0ke.aspx]. Corrections to existing files to follow these standards are welcome.
 === Source Repository (SVN) ===
@@ Line 65: / Line 65: @@
 === Warnings ===
-* Please keep the code warning free, using #pragma only if absolutely necessary.  For instance
+* Please keep the code warning free, using #pragma only if absolutely necessary. For instance
   #pragma warning disable 0612
@@ Line 81: / Line 81: @@
+}
 </pre>
 [[Category:Standards]]