コードスタイル

ここでは、ソースコードを記載する際のコードスタイルについて記載します。
これは汎用的なものであり、別途言語側でのコーディング規約が制定されている場合はそちらを優先してください。

命名規則

関数・変数の名前

  • 小文字のみにする
  • 必要に応じて単語をアンダースコア（ _ ）で区切る
  • 予約後と衝突した場合はアンダースコアを引数名の後ろに追加する
# 変数名の例
my_name
class_

# 関数名の例
def my_function

モジュール名

  • 小文字の短い名前にする
  • アンダースコアをモジュール名に使って良い
# モジュール名の例
my_module

パッケージ名

  • 小文字の短い名前にする
  • アンダースコアをモジュール名に使っても良いが非推奨
# パッケージ名の例
mypackage

クラス名

  • CapWords方式を使う
# クラス名の例
MyClass

※ CapWords方式とは？
命名規則において、最初の1文字を大文字を指定し、次の文字からはキャメルケース(アルファベットで複合の単語を組み合わせる)を用いる方式のことを指します。

例外の名前

  • CapWords方式を使う
  • 実際のエラーの場合は例外の名前の最後に “Error” を付ける
# 例外名の例
MyTestCaseError

関数やメソッドにわたす引数

  • インスタンスメソッドの始めの引数の名前はselfを付ける
  • クラスメソッドのはじめの引数の名前はclsを付ける
# インスタンスメソッドの例
def my_method(self, str1, str2):
    処理

定数

  • 定数は大文字で指定する
  • アンダースコアも化
# 定数名の例
MAX_OVERFLOW
TOTAL