nKB

nKB

シンプルにいこうよ

なのじのコーディング規約


目的
プロジェクトの構成
禁止事項
制限事項
推奨事項


コーディングスタイル

  • コメントがなくても読めるプログラムを書く
  • コードの読みやすさを優先する
  • 見れば分かるコメントは書かない
  • 分かり易さを優先する
  • 変数のスコープは必要以上に大きくしない
  • ソースコードは「AS IS(現在の姿)」であるべき。
     過去の履歴は不要。履歴を残す場合は外部ファイル(.md)に残す
  • ヘッダコメントを付ける
  • データ側、引数の渡し方は明示的に宣言する
  • 戻り値を使用しないプロシージャの呼び出しはCallで行う
  • プロシージャは長くなりすぎないようにする
  • ステートメントは長くなりすぎないようにする
  • 1行の最大長は「79文字」
  • 演算子の前後とコンマの後には空白を入れ、括弧類のすぐ内側には空白を入れないこと


コメント

ヘッダコメント

/**
* @description 役割
* @auther 作成者(イニシャル程度でよい)
* @version バージョン
* @since 作成日
* @update 最終更新日
*/

VBS/VBAの場合

' @description 役割
' @auther 作成者(イニシャル程度でよい)
' @version バージョン
' @since 作成日
' @update 最終更新日


関数コメント

/**
* @brief 要約
* @param 引数 
* @return 戻り値
* @note コメント
*/

VBS/VBAの場合

' @brief 要約
' @param 引数 
' @return 戻り値
' @note コメント

関数名はすぐ下に書いてあるのでわざわざ書かない


命名規約

変数、定数、関数名、クラス名etc


全体

  • 慣例となっているもの、言語で推奨されているものについてはその例に従う。自己流を避ける。
  • SQL予約語は大文字を使用する。


変数・定数

  • 変数・定数は必ず宣言する。強制させる仕組みがある場合は利用する。
    宣言のコメントに正式名称を記載する。
  • 変数名はスネークケース(小文字のみ)。単語をアンダースコアで区切る。(ref. PEP)
  • 変数名に動詞は使わない
  • 変数の文字数は20字以内
  • 短くて済むなら省略しない。10文字以内。
  • 省略すると別の意味となるものは省略しない。
  • 真偽値(Boolean型(true or false))を格納する変数名は「isXXX」
  • 変数宣言エリアを作る(variable declaration)
  • 定数は大文字


関数・クラス

  • 関数名は動詞+目的語にする
  • 関数名は小文字のみ。読みやすくするため、単語をアンダースコアで区切る。
  • クラスや関数定義の間には2行あける
  • クラス名はCapWords形式(最初大文字、その後はキャメルケース)にする(ref. PEP)

変数例 - nKB


テーブル名・カラム名

・テーブル名、カラム名は「小文字+英数字+アンダースコア」を使用する(大文字は使わない)
・スネークケースで記述。
・頭に付ける文字でテーブルの種類を表す。

t_テーブル
q_クエリ
f_フォーム
r_レポート
  • リレーションで関連付けたカラムは同じ名前にする。
  • id、nameのみは使用しない。


外部リンク

PEP 8 -- Style Guide for Python Code | Python.org

はじめに — pep8-ja 1.0 ドキュメント

Google Style Guides | styleguide

EOF