revised code convention for C# for 2017

Author: geryxyz

.editorconfig

@@ -0,0 +1,62 @@
+[*]
+end_of_line = crlf
+
+[*.xml]
+indent_style = space
+
+[*.cs]
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = false
+insert_final_newline = true
+csharp_style_conditional_delegate_call = true:warning
+csharp_style_expression_bodied_accessors = when_on_single_line:warning
+csharp_style_expression_bodied_constructors = when_on_single_line:suggestion
+csharp_style_expression_bodied_indexers = when_on_single_line:warning
+csharp_style_expression_bodied_methods = when_on_single_line:suggestion
+csharp_style_expression_bodied_operators = when_on_single_line:suggestion
+csharp_style_expression_bodied_properties = when_on_single_line:warning
+csharp_style_inlined_variable_declaration = true:warning
+csharp_style_pattern_matching_over_as_with_null_check = true:warning
+csharp_style_pattern_matching_over_is_with_cast_check = true:warning
+csharp_style_throw_expression = true:suggestion
+csharp_style_var_elsewhere = false:error
+csharp_style_var_for_built_in_types = false:error
+csharp_style_var_when_type_is_apparent = true:suggestion
+csharp_new_line_before_catch = true
+csharp_new_line_before_else = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_open_brace = all
+csharp_new_line_between_query_expression_clauses = true
+csharp_indent_case_contents = true
+csharp_indent_labels = one_less_than_current
+csharp_indent_switch_labels = false
+csharp_preserve_single_line_blocks = true
+csharp_preserve_single_line_statements = true
+csharp_space_after_cast = false
+csharp_space_after_keywords_in_control_flow_statements = false
+csharp_space_between_method_call_parameter_list_parentheses = true
+csharp_space_between_method_declaration_parameter_list_parentheses = true
+csharp_space_between_parentheses = expressions
+csharp_prefer_braces = true
+csharp_prefer_simple_default_expression = true
+dotnet_sort_system_directives_first = true
+dotnet_style_coalesce_expression = true:error
+dotnet_style_collection_initializer = true:warning
+dotnet_style_explicit_tuple_names = true:error
+dotnet_style_null_propagation = true:error
+dotnet_style_object_initializer = true:warning
+dotnet_style_predefined_type_for_locals_parameters_members = true:error
+dotnet_style_predefined_type_for_member_access = true:error
+dotnet_style_qualification_for_event = false:suggestion
+dotnet_style_qualification_for_field = false:suggestion
+dotnet_style_qualification_for_method = false:suggestion
+dotnet_style_qualification_for_property = false:suggestion
+dotnet_naming_rule.public_member_PascalCase.symbols = public_symbols
+dotnet_naming_symbols.public_symbols.applicable_kinds = property,method,field,event
+dotnet_naming_symbols.public_symbols.applicable_accessibilities = public
+dotnet_naming_style.PascalCase.capitalization = pascal_case
+dotnet_naming_rule.public_member_PascalCase.style = PascalCase

convention.tex

@@ -50,6 +50,11 @@ \section{Naming}
 var foo = ( _a, _b ) => _a + _b;
 \end{verbatim}
 
+\domark Use the variable name \_ (a single underscore) to denote variables in lambda expressions, which is irrelevant in the current context.
+\begin{verbatim}
+(_, _b) => _b + 1
+\end{verbatim}
+
 \domark Use pascal case in the name of namespaces, classes, interfaces, structures, enumerations and members of enumerations.
 
 \domark Start name of interfaces with a capital I.
@@ -76,6 +81,39 @@ \section{Naming}
 float f_foo;
 \end{verbatim}
 
+\whymark It usually results cryptic abbreviation and types are noted and shown by Visual Studio or any other IDE.
+
+\avoidmark Avoid using single letter variable names.
+\begin{verbatim}
+//avoid
+int a;
+int b;
+
+//do
+int componentA;
+int componentB;
+\end{verbatim}
+
+\notmark Do not mark member with m\_ prefix.
+\begin{verbatim}
+int m_length //wrong
+
+int length //right
+\end{verbatim}
+
+\notmark Do not use white-spaces to construct columns in the source code. 
+\begin{verbatim}
+//do
+int length = 10;
+string name = "Thangorodrim;
+
+//wrong
+int     length  =   10;
+string  name    =   "Thangorodrim;
+\end{verbatim}
+
+\whymark It suggest structures which do not exist.
+
 \avoidmark Avoid uncommon abbreviation. Use abbreviation, when you have no other choice.
 \begin{verbatim}
 string Idkwit = "true"; //I Don't Know What Is This
@@ -102,7 +140,7 @@ \section{Naming}
 void UmlReader()
 \end{verbatim}
 
-\avoidmark Avoid the using the following words, because they are too general to provide useful information.
+\avoidmark Avoid the using the following words.
 \begin{compactitem}
 \item data
 \item information
@@ -111,20 +149,29 @@ \section{Naming}
 \item make
 \end{compactitem}
 
+\whymark Because they are too general to provide useful information.
+
 \notmark Do not use plural form in the name of namespaces, classes, interfaces, structures, enumerations and members of enumerations.
 \begin{verbatim}
+//wrong
 items
 men
+
+//right
+itemCollection
+manCollection
 \end{verbatim}
 
-\notmark Do not put spaces inside empty parentheses.
+\whymark It is easy to misread the plural and singular forms. Can not find irregular forms by searching singulars.
 
 \section{Layout}
 
 \avoidmark Avoid lines longer then 80 characters. Prefer shorter lines as much as possible.
 
 \subsection{Horizontal spacing}
 
+\notmark Do not put spaces inside empty parentheses.
+
 \domark Use spaces at the inner side of all parentheses, except curly braces.
 \begin{verbatim}
 ( Something< int >( _foo[ bla ] ) ) * 10
@@ -136,7 +183,9 @@ \subsection{Horizontal spacing}
 foo++;
 \end{verbatim}
 
-\domark Use tabs instead of spaces at the beginning of the line.
+\domark Use spaces instead of tabs at the beginning of the line.
+
+\domark Use four spaces per each indentation level. 4 spaces = 1 tab
 
 \notmark Do not mix tabs and spaces at the beginning of the line.
 
@@ -176,7 +225,7 @@ \subsection{Line-breaks}
     x + 567567563 / 2121231 + foobar;
 \end{verbatim}
 
-\domark If necessary break line before operators, except parentheses.
+\domark If necessary break line before operators, except parentheses and assignment (=).
 \begin{verbatim}
 string _text =
     "this is a long string need to be"
@@ -188,6 +237,13 @@ \subsection{Line-breaks}
 \end{verbatim}
 
 \domark Put the closing parentheses in the same line with the last parameter, except curly braces.
+\begin{verbatim}
+int grantPermissions( 
+    string user,
+    string password,
+    int id,
+    PersmissionSet permission )
+\end{verbatim}
 
 \domark If necessary prefer to start method calls in a new line.
 
@@ -202,8 +258,6 @@ \subsection{Line-breaks}
 
 \subsection{Vertical spaces}
 
-\notmark Do not put empty line around opening parentheses.
-
 \domark Separate members in classes with an empty lines.
 \begin{verbatim}
 private
@@ -219,4 +273,12 @@ \section{Commenting}
 
 \notmark Do not use block comments (/* */).
 
+\appendix
+
+\chapter{C\#}
+
+\section{EditorConfig for Visual Studio}
+
+For further details and \emph{some} automatic style and convention settings please use the \texttt{.editorcongif} file next to this document. It only contains Visual Studio and C\#{} specific settings. This file do not cover every details present in this documents and provided \emph{as is}.
+
 \end{document}