Difference between revisions of "Team Excellence - oop344 20113 Code Standards"

From CDOT Wiki
Jump to: navigation, search
(If Statement)
(Class Standards)
 
(7 intermediate revisions by one other user not shown)
Line 7: Line 7:
 
== If Statement ==
 
== If Statement ==
  
'''Sandip:'''
 
I have a proposal. How about doing it like this:
 
<syntaxhighlight lang="cpp">
 
if (condition)
 
{
 
  stuff;
 
}
 
else if (condition)
 
{
 
  stuff;
 
}
 
else
 
{
 
  stuff;
 
}
 
</syntaxhighlight>
 
  
 
'''Dzmitry:'''
 
'''Dzmitry:'''
Line 29: Line 13:
 
if (condition){
 
if (condition){
 
     stuff;
 
     stuff;
}else if (condition){
+
} else if (condition){
 
     stuff;
 
     stuff;
}else{
+
} else{
 
     stuff;
 
     stuff;
 
}
 
}
Line 42: Line 26:
 
== For Loop ==
 
== For Loop ==
 
<syntaxhighlight lang="cpp">
 
<syntaxhighlight lang="cpp">
for (i=0; condition; i++)
+
for (i=0; condition; i++){
{
 
 
   stuff;
 
   stuff;
 
}
 
}
Line 53: Line 36:
 
== While Loop ==
 
== While Loop ==
 
<syntaxhighlight lang="cpp">
 
<syntaxhighlight lang="cpp">
while (true)
+
while (true){
{
 
 
   stuff;
 
   stuff;
 
}
 
}
Line 87: Line 69:
 
**/
 
**/
  
#ifndef _CLASS_
+
#ifndef _INITIAL_CLASS_
#define _CLASS_
+
#define _INITIAL_CLASS_
  
 
class CLASS {
 
class CLASS {
 
      
 
      
           int a;
+
           int _a;
           int b;
+
           int _b;
  
 
   public:
 
   public:
Line 113: Line 95:
  
 
       /* Again Important Header goes here */
 
       /* Again Important Header goes here */
           if(condition)
+
           if(condition){
          {
 
 
                 stuffs;
 
                 stuffs;
 
           }
 
           }
  
 
       /* All Loops */
 
       /* All Loops */
           for(i=0; i<len; i++)
+
           for(i=0; i<len; i++){
          {
 
 
               statements;
 
               statements;
 
           }
 
           }
 
            
 
            
           while(condition)
+
           while(condition){  
          {  
 
 
               statements;
 
               statements;
 
           }
 
           }

Latest revision as of 22:53, 18 October 2011


OOP344 | Weekly Schedule | Student List | Teams | Project | Student Resources

Code Standards

Sandip: I have a proposal. How about doing it like this:

If Statement

Dzmitry: I have a proposal. How about doing it like this:

if (condition){	
    stuff;
} else if (condition){
    stuff;
} else{
    stuff;
}

That will save a few lines, also space between "stuff" and beginning of the line should be default Visual Studio Tab (Mine is 4 spaces).

Jitender: Guys, we should agree one of the standard, I agree with Dzmitry proposal, it short and easy to follow

For Loop

for (i=0; condition; i++){
  stuff;
}

Notice the space after the 'for' and the lack of space between the ')' and '{'

Similar deal as with the if statement if "stuff" is only one like the curly braces can be omitted.

While Loop

while (true){
  stuff;
}

Notice the space after the 'while' and the lack of space after the ')' and '{'.

Also the curly braces can be omitted if "stuff" is only one line.

Function Declarations

void foo(int a){
  stuff;
}

The function header isn't indented at all and the first line follows immediately after with one indent.

Also there's no space between the ')' and '{'.

Indents

I think each indent should be the equivalent of two spaces. You can change the settings of Visual Studio to put in 2 spaces whenever you press tab. This will keep the code properly aligned and if someone isn't used to using tab for indent they can easily just use two spaces.

Dzmitry: I think at least 3-4 spaces will be better. First of all, it makes code easier to read (less characters on a page) and original console.cpp (at least for me) is written with 4 spaces spacing, so we won't need to change professor's code.

Class Standards

Header File Standards:

/**
*   class.h
*   Sandip Patel  
*   October 12, 2011
**/

#ifndef _INITIAL_CLASS_
#define _INITIAL_CLASS_

class CLASS {
     
          int _a;
          int _b;

  public:
          function();
}

#endif

All Cpp File Standards:

/* Function Starts here */
function name() {

       /* Header goes here */
          int key = 0;           // Comment goes here
          bool done = false;

       /* Again Important Header goes here */
          if(condition){
                stuffs;
          }

       /* All Loops */
          for(i=0; i<len; i++){
              statements;
          }
          
          while(condition){ 
              statements;
          }

}
/* function ends here */

Comments

Dzmitry:

int foo(int x);   // this comment is an example

File Header

Suggested By: Sandip Patel

/**
*   test.cpp
*   Sandip Patel  
*   October 12, 2011
**/