參考：http://wiki.ros.org/CppStyleGuide

可以使用clang-format來自動格式化（不要理解錯了,formatting）你的程式碼.

1、命名規則

有以下幾種命名格式：

• CamelCased：名稱以大寫字母開頭，每個新單詞都有大寫字母，不帶下劃線。
  

• camelCased：和CamelCase一樣，但是用小寫的第一個字母

• under_scored：該名稱只使用小寫字母，單詞之間用下劃線分隔。

• ALL_CAPITALS：所有大寫字母，單詞之間用下劃線分隔。

ROS的功能包名稱使用under_scored;

檔案使用under_scored（如果檔案內實現的是一個類，則把類名變為這種格式來給檔案命名）;

庫使用under_scored（與lib之間不要有下劃線如libmy_girls）;

類或型別使用CamelCased（縮寫全大寫）；

函式或方法使用camelCased，引數使用under_scored，函式名通常表示動作，應把動詞放前面；

變數使用under_scored，合理描述，儘量不要模糊，更長的變數名不會佔用更多空間。積分迭代器變數可以非常短，如i，j，k。 在你如何使用迭代器方面保持一致（例如，i在外部迴圈中，j在下一個內部迴圈中）；

常量使用ALL_CAPITALS；

成員變數在under_scored後面新增下劃線，如example_int_;

全域性變數在under_scored前加g_

名稱空間使用under_scored；

2、格式規定

每塊縮排2個空格，切勿插入文字標籤字元，名稱空間的內容不縮排，成對的大括號要在一條線上。例如：

if(a < b)
{
  // do stuff
}
else
{
  // do other stuff
}

例子：

/*
 * A block comment looks like this...
 */
#include <math.h>
class Point
{
public:
  Point(double xc, double yc) :
    x_(xc), y_(yc)
  {
  }
  double distance(const Point& other) const;
  int compareX(const Point& other) const;
  double x_;
  double y_;
};
double Point::distance(const Point& other) const
{
  double dx = x_ - other.x_;
  double dy = y_ - other.y_;
  return sqrt(dx * dx + dy * dy);
}
int Point::compareX(const Point& other) const
{
  if (x_ < other.x_)
  {
    return -1;
  }
  else if (x_ > other.x_)
  {
    return 1;
  }
  else
  {
    return 0;
  }
}
namespace foo
{
int foo(int bar) const
{
  switch (bar)
  {
    case 0:
      ++bar;
      break;
    case 1:
      --bar;
    default:
    {
      bar += bar;
      break;
    }
  }
}
} // end namespace foo
 

1）單行長度不要超過120個字母。

2）標頭檔案必須包含#ifndef，例如：

#ifndef PACKAGE_PATH_FILE_H
#define PACKAGE_PATH_FILE_H
...
#endif

3、控制檯輸出

使用rosconsole代替cout，printf等等輸出命令。它有以下優點：

• color-coded
• controlled by verbosity level and configuration file

• published on /rosout, and thus viewable by anyone on the network (only when working with roscpp)

• optionally logged to disk

4、儘可能避免使用前處理器巨集。

5、對於條件編譯，要使用#if ,而不使用#ifdef；

6、方法/函式的（即函式可以修改的變數）輸出引數是通過指標傳遞的，而不是通過引用傳遞的。

7、名稱空間

鼓勵使用名稱空間限制程式碼，但是注意命名合理，具有描述性。

注意切勿在標頭檔案中使用using指令， 這樣做會汙染包含標題的所有程式碼的名稱空間。

原始檔中使用using命令是acceptable，但是最後使用你使用的名稱。例如

不要這樣：

using namespace std; // 不好，因為它引入了標準庫中的所有命名

要這樣：

using std::list;  // I want to refer to std::list as list
using std::vector;  // I want to refer to std::vector as vector

8、繼承

繼承是定義和實現通用介面的適當方式。 基類定義了介面，並且子類實現它。

繼承也可以用來提供從基類到子類的通用程式碼。 這種繼承的使用是不鼓勵的。 在大多數情況下，“子類”可以使用“基類”的例項（就是在其中宣告具體物件），來獲得相同的結果，但混淆的可能性較小。

當重寫子類中的虛擬函式時，總是宣告它是virtual的，以便讀者知道發生了什麼。

強烈建議不要使用多繼承。

9、異常

異常是首選的錯誤報告機制，而不是返回整數錯誤程式碼。

始終記錄每個函式/方法可以丟擲什麼異常。

不要從解構函式中丟擲異常。

不要從不直接呼叫的回撥中丟擲異常。

如果您在軟體包中選擇使用整數錯誤程式碼而不是異常，請僅使用錯誤程式碼。 始終如一。

當代碼可能被異常中斷時，您必須確保當堆疊變數超出範圍時，您持有的資源將被釋放。 特別是，必須釋放互斥鎖，並且必須釋放堆分配的記憶體。 通過使用以下互斥量守護程式和智慧指標來實現此安全性。

10、列舉型別

使用名稱空間包括您的列舉

namespace Choices
{
  enum Choice
  {
     Choice1,
     Choice2,
     Choice3
  };
}
typedef Choices::Choice Choice;

這可以防止列舉汙染它們所在的名稱空間。 列舉中的單個專案被引用為：Choices :: Choice1，但typedef仍允許宣告Choice列舉而不使用名稱空間。

11、全域性

全域性變數和函式都是不鼓勵的。 它們汙染了名稱空間並使程式碼更少重用。

全球變數，特別是，強烈不鼓勵。 它們阻止了一段程式碼的多個例項，並使多執行緒程式設計成為一場噩夢。

大多數變數和函式應該在類中宣告。 其餘部分應在名稱空間內宣告。

例外：一個檔案應包含一個main（）函式和少數幾個全域性小幫助函式。 但請記住，有一天，這些幫助函式可能對其他人有用。

12、不鼓勵靜態類變數。 它們阻止了一段程式碼的多個例項，並使多執行緒程式設計成為一場噩夢。

13、exit()

只能在應用程式的明確定義的出口點呼叫exit（）。

切勿在庫中呼叫exit（）。

14、斷言

使用斷言來檢查先決條件，資料結構完整性和記憶體分配器的返回值。 斷言比編寫條件語句要好，如果這些條件語句很少會被執行的話。

不要直接呼叫assert（）。 而是使用ros/assert.h（rosconsole包的一部分）中宣告的這些函式之一：

/** ROS_ASSERT asserts that the provided expression evaluates to
 * true.  If it is false, program execution will abort, with an informative
 * statement about which assertion failed, in what file.  Use ROS_ASSERT
 * instead of assert() itself.
 */
#define ROS_ASSERT(expr) ...

/** ROS_BREAK aborts program execution, with an informative
 * statement about which assertion failed, in what file. Use ROS_BREAK
 * instead of calling assert(0) or ROS_ASSERT(0).
 */                                                         
#define ROS_BREAK() ...

此外還有一些規則沒有列出，可以進入ROS wiki檢視。

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~補充一些其他的約定，我們約～～～～～～～～～～～～～～～～

附1、訊息單位的規定(SI)

附2、座標的規定

使用右手定則，右手握向為正方向。並且必須以x：forward，y：left，z：up的形式進行程式設計。