Coding style - Revision history

Mitjajancic: /* Using your IDE auto formatter */

2020-11-30T13:06:11Z

‎Using your IDE auto formatter

2020-11-30T13:00:08Z

Updated .clang-format.

2020-11-19T12:57:44Z

‎Using your IDE auto formatter: Column limit 100

2020-11-19T12:49:41Z

Added coding style .clang-format file.

2020-11-19T12:48:46Z

Added coding style clang-format

2020-11-19T12:47:23Z

2020-11-18T13:34:22Z

2020-11-18T13:33:47Z

2019-09-08T16:25:48Z

‎Naming convention

2018-08-07T10:31:29Z

@@ Line 113: / Line 113: @@
 # Do not sort includes.
-SortIncludes:false
+SortIncludes: false
 </syntaxhighlight>

@@ Line 111: / Line 111: @@
 DerivePointerAlignment: false
 PointerAlignment: Left
 </syntaxhighlight>

@@ Line 104: / Line 104: @@
 AccessModifierOffset: -2
 IndentWidth: 4
-ColumnLimit: 0
+ColumnLimit: 100
 # Some folks prefer to write "int& foo" while others prefer "int &foo".  The

← Older revision		Revision as of 12:49, 19 November 2020
Line 93:		Line 93:
	</syntaxhighlight>		</syntaxhighlight>
	For null pointer we use <syntaxhighlight lang="c++" inline> nullptr </syntaxhighlight> instead of <syntaxhighlight lang="c++" inline> NULL </syntaxhighlight> macro.		For null pointer we use <syntaxhighlight lang="c++" inline> nullptr </syntaxhighlight> instead of <syntaxhighlight lang="c++" inline> NULL </syntaxhighlight> macro.
		+
		+	=Using your IDE auto formatter=
		+	Most available IDEs support source code formatting using [https://clang.llvm.org/docs/ClangFormat.html clang-format]. We recommend using coding style based on Google, with minor modifications concerning indentation and pointer location.
		+
		+	<syntaxhighlight>
		+	# Use the Google style in this project.
		+	BasedOnStyle: Google
		+
		+	# Custom adjustments.
		+	AccessModifierOffset: -2
		+	IndentWidth: 4
		+	ColumnLimit: 0
		+
		+	# Some folks prefer to write "int& foo" while others prefer "int &foo". The
		+	# Google Style Guide only asks for consistency within a project, we chose
		+	# "int& foo" for this project:
		+	DerivePointerAlignment: false
		+	PointerAlignment: Left
		+	</syntaxhighlight>
		+
		+	More information about auto formatting in:
		+	* [https://code.visualstudio.com/docs/cpp/cpp-ide Visual Studio Code],
		+	* [https://www.jetbrains.com/help/clion/clangformat-as-alternative-formatter.html Jetbrains Clion]

← Older revision		Revision as of 12:48, 19 November 2020
Line 93:		Line 93:
	</syntaxhighlight>		</syntaxhighlight>
	For null pointer we use <syntaxhighlight lang="c++" inline> nullptr </syntaxhighlight> instead of <syntaxhighlight lang="c++" inline> NULL </syntaxhighlight> macro.		For null pointer we use <syntaxhighlight lang="c++" inline> nullptr </syntaxhighlight> instead of <syntaxhighlight lang="c++" inline> NULL </syntaxhighlight> macro.
−
−	~~=Using your IDE auto formatter=~~
−	Most available IDEs support source code formatting using [https://clang.llvm.org/docs/ClangFormat.html clang-format]. We recommend using coding style based on Google, with minor modifications concerning indentation and pointer location.
−
−	~~<syntaxhighlight>~~
−	~~# Use the Google style in this project.~~
−	~~BasedOnStyle: Google~~
−
−	~~# Custom adjustments.~~
−	~~AccessModifierOffset: -2~~
−	~~IndentWidth: 4~~
−	~~ColumnLimit: 0~~
−
−	~~# Some folks prefer to write "int& foo" while others prefer "int &foo". The~~
−	~~# Google Style Guide only asks for consistency within a project, we chose~~
−	~~# "int& foo" for this project:~~
−	~~DerivePointerAlignment: false~~
−	~~PointerAlignment: Left~~
−	~~</syntaxhighlight>~~
−
−	~~More information about auto formatting in:~~
−	* [https://code.visualstudio.com/docs/cpp/cpp-ide Visual Studio Code],
−	* [https://www.jetbrains.com/help/clion/clangformat-as-alternative-formatter.html Jetbrains Clion]

← Older revision		Revision as of 12:47, 19 November 2020
Line 93:		Line 93:
	</syntaxhighlight>		</syntaxhighlight>
	For null pointer we use <syntaxhighlight lang="c++" inline> nullptr </syntaxhighlight> instead of <syntaxhighlight lang="c++" inline> NULL </syntaxhighlight> macro.		For null pointer we use <syntaxhighlight lang="c++" inline> nullptr </syntaxhighlight> instead of <syntaxhighlight lang="c++" inline> NULL </syntaxhighlight> macro.
		+
		+	=Using your IDE auto formatter=
		+	Most available IDEs support source code formatting using [https://clang.llvm.org/docs/ClangFormat.html clang-format]. We recommend using coding style based on Google, with minor modifications concerning indentation and pointer location.
		+
		+	<syntaxhighlight>
		+	# Use the Google style in this project.
		+	BasedOnStyle: Google
		+
		+	# Custom adjustments.
		+	AccessModifierOffset: -2
		+	IndentWidth: 4
		+	ColumnLimit: 0
		+
		+	# Some folks prefer to write "int& foo" while others prefer "int &foo". The
		+	# Google Style Guide only asks for consistency within a project, we chose
		+	# "int& foo" for this project:
		+	DerivePointerAlignment: false
		+	PointerAlignment: Left
		+	</syntaxhighlight>
		+
		+	More information about auto formatting in:
		+	* [https://code.visualstudio.com/docs/cpp/cpp-ide Visual Studio Code],
		+	* [https://www.jetbrains.com/help/clion/clangformat-as-alternative-formatter.html Jetbrains Clion]

@@ Line 68: / Line 68: @@
 </syntaxhighlight>
-Use doxygen comments to generate [documentation | http://e6.ijs.si/medusa/docs/html/].
+Use doxygen comments to generate [http://e6.ijs.si/medusa/docs/html/ documentation].
 =Headers =

@@ Line 31: / Line 31: @@
 namespaces - one lowercase word, maybe shortened, eg. <syntaxhighlight lang="c++" inline> op </syntaxhighlight>. For internal implementation details use <syntaxhighlight lang="c++" inline> op_internal </syntaxhighlight>. Namespace closing brace should contain comment  `// namespace your_name`. There is no indentation within namespaces.
-All standard abbreviations like [[Moving Least Squares (MLS)| Moving Least Squres (MLS)]] or [https://en.wikipedia.org/wiki/Finite_element_method Finite Elements Method (FEM)] -
+All standard abbreviations like [[Weighted Least Squares (WLS)]] or [https://en.wikipedia.org/wiki/Finite_element_method Finite Elements Method (FEM)] -
 <syntaxhighlight lang="c++" inline>UPPER_CASE</syntaxhighlight>

@@ Line 6: / Line 6: @@
 =General=
-A 100 characters line width limit.
+We use a 100 characters line width limit in C++ code.
 =Indentation=
-Indent using spaces. Indentation width is $4$ spaces.
+Indent using spaces. Indentation width is 4 spaces.
 <syntaxhighlight lang="c++">
 for (int i = 0; i < 10; i++) {