coding_style.md

コーディングスタイル

• 変数名等を決めるのに役立つサイト

目次

1. プログラムでのコーディングスタイル
   1. 命名規則の基本
   2. ROSでの命名規則
   3. C++でのコーディングスタイル
   4. Pythonでのコーディングスタイル

---

2. ディレクトリでのコーディングスタイル
   1. 基本的なディレクトリの命名規則
   2. ROSでのディレクトリの命名規則

プログラムでのコーディングスタイル

命名規則の基本

命名規則名	補足
PascalCase	単語の頭文字はすべて大文字
camelCase	初めの単語だけ頭小文字
snake_case	単語すべて小文字、単語間はアンダースコアで結ぶ
ALL_CAPITALS	全て大文字の単語をアンダースコアで接続したもの

ROSでの命名規則

命名種類	命名規則
パッケージ名	snake_case
トピック名	snake_case
トピック型名	PascalCase
サービス名	snake_case
サービス型名	PascalCase
アクション名	snake_case
アクション型名	PascalCase
ファイル名	snake_case

C++でのコーディングスタイル

命名種類	命名規則
ローカル変数名	snake_case
グローバル変数名	g_ + snake_case
メンバー変数	snake_case + _
定数名	ALL_CAPITALS
関数名	camelCase
クラス名	PascalCase
インデント	スペース4つ
ソースファイルの拡張子	.cpp
ヘッダファイルの拡張子	.h
1行の長さ	最大値は120文字

参考URL(C++)

• ROS公式 C++ スタイルガイド

Pythonでのコーディングスタイル

命名種類	命名規則
変数名	snake_case
定数名	ALL_CAPITALS
関数名	snake_case
クラス名	PascalCase
グローバルな変数・関数	命名規則 + _global
インデント	スペース4つ

参考URL(C++)

• ROS公式 Python スタイルガイド

ディレクトリでのコーディングスタイル

基本的なディレクトリの命名規則

ディレクトリの種類	命名規則
C++のソースファイル	src
C++のヘッダファイル	include/パッケージ名
Pythonのプログラム	scripts
設定ファイル	config
画像	img

ROSでのディレクトリの命名規則

ディレクトリの種類	命名規則
launchファイル	launch
rvizファイル	rviz
CADファイル	meshes
xacroファイル(統合)	robots
xacroファイル(要素)	urdf
urdfファイル	urdf

---

トップに戻る