OSDev.org

Code: Select all

#define MACROS_ALWAYS_UPPER_CASE(_parameters_underscore_prefixed) 
namespace CamelCased {

class CamelCased {
public:
   void methodJavaCased(int asAreParameters)
   int someVal(); // getters have no prefix
   void setSomeVal(); // setters have set prefix
private:
    int m_membersHaveAPrefix;
    static int ms_asDoStatics;

    // if this class is pImpl style, then the p is called m
    CamelCasedPrivate* m;
};

enum MoreCamelCasing {
    ConstantsAreCamelCasedToo = 0,
    // in general, the enumeration values should end with something related to what they're defining
};

const int ExampleOfAConstant = 0;
}

// All function names are javaCased
void function() {
    int variableName; // Variables in functions are javaCased
}

Code: Select all

// These two for special corner cases
#define PRJ_CONCAT2(_a, _b) _a##_b
#define PRJ_CONCAT(_a, _b) PRJ_CONCAT2(_a, _b)
#define PRJ_GEN_NAME(_name) PRJ_CONCAT(PRJ_CONCAT(PRJ_CONCAT(_i_PrjName, __LINE__), __FILE__), _name)

Code: Select all

#define MACRO_CATEGORY_SUBCAT_VERBOSE_PURPOSE(__param)   (__param)

//Post-fix classes with capital C. Structs with capital S.
class lowerCamelCaseC {
   friend class creepyClassC;
   public:
      lowerCamelCaseC();
      ~lowerCamelCaseC();

   public:
      type myMethod();

   private:
      int moreLowerCamelCase;
};

Code: Select all

/** EXPLANATION:
 * This is an explanation block which is placed before any code in the file, after the #includes.
 * ...
 **/

/* General multiline comment.
 * Which spans multiple lines.
 **/

//Single line comment in C and C++
/* Single line comment in ASM. (I use GNU AS) */

;;When using NASM, etc, I form my comments like this, with two semi-colons

Code: Select all

for (simple-expression;
   ((fully-bracketed) || (complex-expression));
   expression
   )
{};

while (expression) {
   //Even for single line block statements, I still place the braces in.
};

Code: Select all

#define MACRO_UPPERCASE(paramsCamel)

class CamelClass
{
   methodJavaCase(paramsCamel);

   privateStuffJavaCase;
}

Code: Select all

unit MyUnit;

{$mode objfpc}{$H+}

interface

uses
  Unit1,Unit2;

type
  TSomeClass = class
  private
    FProp: LongInt;
  public
    property Prop: LongInt read FProp;
    constructor Create;
    destructor Destroy;
    procedure Proc;
    function Func: LongInt;
  end;

implementation

constructor TSomeClass.Create;
begin
end;

destructor TSomeClass.Destroy;
begin
end;

procedure TSomeClass.Proc;
var
  i: LongInt;
begin
  for i:=1 to 10 do begin
    ...;
  end;
  repeat
    ...
  until ...;
end;

function TSomeClass.Func: LongInt;
begin
  while ... do begin
    ...;
  end;
  case Result of
    0: ...;
    1: ...;
    otherwise ...;
  end; 
end;

end.

Code: Select all

#define A_CONSTANT 255

typedef struct {
  int i;
  char c;
} TMyStruct;

int func() {
  for (int i=0;i<10;i++) {
    ...;
  }
  while (...) {
    ...;
  }
  return 0;
}

void proc() {
  do {
    ...;
  while (...);
  switch (...) {
    case 0:
      ...;
    break;
    case 1:
      ...;
    break;
    default:
      ...;
  }
}

Code: Select all

// debugging comment (if C++ style supported)
/* regular comment */
/*** important comment ***/
/***** really important comment *****/
/***** SEPARATOR *****/

/*
 * Multiple line comment.
 */

#ifndef SENTRY
#define SENTRY

/* header stuff */

#endif/*SENTRY*/

#define CONSTANT 1
#define MULTI_WORD_CONSTANT 2
#define MACRO(n) ((n) + 42)
#define MULTI_LINE_MACRO(v) \
do { \
 ... \
} while (0);

struct stuff {
 int q;
 struct stuff *next_stuff;
} stuff_t;

int some_function(int a, char *b) {
 int foo;
 stuff_t bar;
 int *z = (void*) b;
 int i;

 switch (b[2]) {
 case 'a':
  ...
  break;
 case 'q':
  ...
  break;
 }

 if (a & (1 << 5)) {
  foo = 42;
 }
 else {
  foo = 66;
 }

 bar.q = 0;
 for (i = 0; i < foo; i++) {
  bar.q += (foo * 5) + i;
 }

 return (z) ? 123 : 321;
}