この文書では,マイコン応用で作成するプログラムの命名法について述べます.

  • C言語
    • 関数
          • グローバル関数は「ソースファイル名_関数名」とします.関数名は最初の文字だけ小文字であるキャメルケースとします.
            • 例:IntervalTimer.c内にあるsetCallbackFunctionの場合 ,IntervalTimer_setCallbackFunction
          • スタティック関数は「_
      最初の文字だけ小文字であるキャメルケース
        」とします.
        • 例:DotMatrixDisplay.c内にあるclearColumnの場合,_clearColumn
    • 変数
        • グローバル変数は「最初の文字だけ小文字であるキャメルケース」とします
          • 例:someValue
        • ソース内からしかアクセスできず,かつローカル変数でないスタティック変数は「_最初の文字だけ小文字であるキャメルケース」とします.
        • 例:_someValue
      • ローカル変数(関数内しかアクセスできない変数)は「全部小文字のスネークケース」とします.ここには,ローカルなスタティック変数を含みます.
        • 例:some_value
    • 定数
      • グローバル定数は「全部大文字のスネークケース」とします.
        • 例:SOME_CONSTANT_VALUE
      • ソース内からしかアクセスできず,かつローカル変数でないスタティック定数は「_全部大文字のスネークケース」とします.
        • 例:_SOME_CONSTANT_VALUE
      • ローカルな定数は「_全部大文字のスネークケース」とします.ここには,ローカルなスタティック定数を含みます.
        • 例:_SOME_CONSTANT_VALUE
    • 構造体
      • 「キャメルケース」とします.
        • 例:ZigBeeFrame
    • 列挙型
      • 「キャメルケース」とします.
        • 例:FrameType
  • C++言語
    • メンバ関数
      • パブリックな関数は「最初の文字だけ小文字であるキャメルケース」とします.
        • 例:setValue
      • プライベートな関数は「_最初の文字だけ小文字であるキャメルケース」とします.
        • 例:_setValue
      • プロテクテットな関数は,プライベートな関数と同じとします.
    • メンバ変数
      • パブリックな変数は作らないです.
      • プライベートな変数は「_最初の文字だけ小文字であるキャメルケース」とします.
      • プロテクテットな変数は,プライベートな変数と同じとします.
    • メンバ定数
      • パブリックな定数は「全部大文字のスネークケース」とします.
        • 例:SOME_CONSTANT_VALUE
      • プライベートな定数は「_全部大文字のスネークケース」とします.
        • 例:_SOME_CONSTANT_VALUE
      • プロテクテットな定数は,プライベートな定数と同じとします.
    • クラス
      • 「キャメルケース」とします.
        • 例:ZigBeeFrame
    • インタフェース
      • 「I + キャメルケース」とします.
        • 例:IChangeListener
    • 実現したクラス
      • 「実現したクラス + Impl」とします.
        • 例:IChangeListenerImpl
    • 構造体
      • C言語と同じとします.
    • 列挙型
      • C言語と同じとします.
JSN Teki is designed by JoomlaShine.com