コーディング規約（サンプル例）

目的

本コーディング規約は○○プロジェクトにおける開発時に適用されます。既存開発メンバーの情報共有はもちろんのこと、これから新しく入ってくるメンバーに対しても速やかに情報共有されるべく、記述されています。

本コーディング規約はごく基本的な項目に限って記述しています。新しく出てきた不明点があれば、随時更新されます。

プロジェクトの構成

○○プロジェクトのファイル構成は次のようになっています。

命名規則

変数名はキャメルケースとします。

クラス名は必ず大文字ではじめてください。クラス名のプリフィックスは NP とします。

コーディングスタイル

基本的なコーディング規約は○○○○に従います。なおインデントはTabではなくスペース2文字とします。

禁止事項

if文の中で変数に代入するのは禁止とします。

if (const key = hoge()) {

} else {

}

ifを記述したら必ずelseを記述してください。ifのみ、if/elseif のみは禁止です。

制限事項

HTML表示を行う際には必ずNPViewを利用してください。

推奨事項

• NPMailerはテキストメール用です。
• NPHTMLMailerはHTMLメール用です。

【おすすめの情報共有ツール】

このテンプレートを表示している、マニュアル作成・ナレッジ管理ツール「NotePM」 は、社員が登録したさまざまなナレッジを蓄積し、強力な検索機能でほしい情報がすぐに見つけられるサービスです。マニュアル、手順書、報告書、ノウハウ、社内FAQ、日報、議事録など、何度も検索するようなストック型の情報管理に便利です。

NotePM公式サイト：https://notepm.jp/