Standards for Programming Style - Revision history

Dvernon at 08:46, 20 January 2020

2020-01-20T08:46:47Z

2015-02-17T08:25:41Z

2015-02-15T12:24:05Z

2014-10-06T08:28:32Z

2014-08-29T15:05:10Z

‎Compound Statements

2014-08-29T15:04:13Z

‎Initialization

2014-08-29T15:04:00Z

‎Placement

2014-08-29T15:02:47Z

‎Number Per Line

2014-08-29T15:01:56Z

2014-08-29T14:59:59Z

← Older revision		Revision as of 08:46, 20 January 2020
Line 280:		Line 280:

	If you really hate the JavaDoc format, use the second format, but be consistent and stick to it throughout your code.		If you really hate the JavaDoc format, use the second format, but be consistent and stick to it throughout your code.
−
−
−	~~----~~
−	~~Return to [[The CINDY Cognitive Architecture]] main page.~~

@@ Line 170: / Line 170: @@
 ===C vs. C++===
-Naming conventions make programs more understandable by making them easier to read. Since DREAM software uses both the C language and the C++ language, sometimes using the imperative programming and object-oriented programming paradigms separately, sometimes using them together, we will adopt two different naming conventions, one for C and the other for C++. The naming conventions for C++ are derived from the JavaDoc standards.
+Naming conventions make programs more understandable by making them easier to read. Since CINDY software uses both the C language and the C++ language, sometimes using the imperative programming and object-oriented programming paradigms separately, sometimes using them together, we will adopt two different naming conventions, one for C and the other for C++. The naming conventions for C++ are derived from the JavaDoc standards.
 ===C++ Language Conventions===
@@ Line 280: / Line 280: @@
 If you really hate the JavaDoc format, use the second format, but be consistent and stick to it throughout your code.

← Older revision		Revision as of 08:28, 6 October 2014
Line 3:		Line 3:


−	Do not use tabs to indent text. If you are using Microsoft Visual C++ turn off the tabs option (go to Tools -> Options -> Text Editor -> C/C+ -> Tabs+ and click the insert spaces radio button; you can set the number of spaces to three or four here too).	+	Do not use tabs to indent text. If you are using Microsoft Visual C++ turn off the tabs option (go to Tools -> Options -> Text Editor -> C/C++ -> Tabs and click the insert spaces radio button; you can set the number of spaces to three or four here too).

@@ Line 92: / Line 92: @@
 A return statement with a value should not use parentheses unless they make the return value more obvious in some way. For example:
-   return;
+ return;
-   return myDisk.size();
+ return myDisk.size();
-   return TRUE;
+ return TRUE;
 <code>if,if-else,if else-if else</code> Statements

@@ Line 40: / Line 40: @@
 ===Initialization===
 Initialize local variables where they are declared. The only reason not to initialize a variable where it’s declared is if the initial value depends on some computation occurring first.
 ==Placement==

← Older revision	Revision as of 12:24, 15 February 2015
(No difference)

← Older revision		Revision as of 15:04, 29 August 2014
Line 47:		Line 47:

	void myMethod() {		void myMethod() {
−	int int1 = 0; // beginning of method block	+	int int1 = 0; // beginning of method block
−	if (condition) {	+	if (condition) {
−	int int2 = 0; // beginning of "if" block	+	int int2 = 0; // beginning of "if" block
−	...	+	...
−	}	+	}
−	}	+	}

	===Class Declarations===		===Class Declarations===

@@ Line 36: / Line 36: @@
 Do not put different types on the same line:
-   int foo, fooarray[]; //WRONG!
+ int foo, fooarray[]; //WRONG!
 ===Initialization===

← Older revision		Revision as of 15:01, 29 August 2014
Line 1:		Line 1:
−	~~<strong>WORK IN PROGRESS ... DON'T READ</STRONG>~~
−
	== Indentation and Line Breaks ==		== Indentation and Line Breaks ==
	Either three or four spaces should be used as the unit of indentation. Choose one standard and stick to it throughout the code.		Either three or four spaces should be used as the unit of indentation. Choose one standard and stick to it throughout the code.

@@ Line 235: / Line 235: @@
 |Functions       ||  Function names should be all lowercase with words  || <code>int  display_image()</code>
 |-
-|                ||  separated by underscores <code>_</code>}         || <code>void set_motor_control()</code>
+|                ||  separated by underscores <code>_</code>        || <code>void set_motor_control()</code>
 |-
 |                ||                                                     ||
@@ Line 241: / Line 241: @@
 |Variables       ||  variable names should be all lowercase with words  || <code>int    i;</code>
 |-
-|                ||  separated by underscores <code>_</code>}         || <code>float  f;</code>
+|                ||  separated by underscores <code>_</code>       || <code>float  f;</code>
 |-
 |                ||  of each internal word capitalized                  || <code>double pixel_value;</code>
@@ Line 249: / Line 249: @@
 |Constants       ||  Constants should be all uppercase with words       || <code>#define WIDTH 4</code>
 |-
-|                ||  separated by underscores <code>_</code>}         ||
+|                ||  separated by underscores <code>_</code>}      ||
 |-
 |                ||                                                     ||