nDiki : Naney メソッド命名規則

Naney メソッド命名規則 - Naney method naming convention

私的メソッド命名規則

enable/disable の設定 / 取得

 $obj->set_enabled($boolean)
 $boolean = $obj->is_enabled;

 $obj->set_xxx_enabled($boolean)
 $boolean = $obj->is_xxx_enabled;

数を返す

 $int = $obj->count;
 $int = $obj->xxx_count;
 $int = $obj->size;

存在するかどうかを返す

 $boolean = $obj->exists;

 NG
 $boolean = is_exist;

有効かどうかを返す

 $boolean = $obj->is_valid;

定義されているかどうかを返す

 $boolean = $obj->is_defined;

コンテナオブジェクトが要素を含んでいるかを返す

 $boolean = $obj->has($element);
 $boolean = $obj->contains($element);

 $boolean = $obj->has_xxx($element);
 $boolean = $obj->contains_xxx($element);

登録する

 $obj->register($data)
 $obj->register_xxx($data)
 NG
 $obj->regist($data)

要素を検索する

 $obj->find(...)
 $obj->find_X_by_Y(...)

インデックスを返す

 $obj->index_of

削除する

 $obj->remove;
 $obj->remove_at(...);
 $obj->remove_all;

文字列に変換する

 $obj->to_string;

複製を作る

 $obj->clone;

Perl における命名規則

Naney Perl Coding Standardsより。

  • protected なメソッド名はアンダースコア 1 個で始める。
  • private なメソッド名はアンダースコア 2 個で始める。

Perl ベストプラクティス 3.1 より

 <ルーチン> : <命令法の動詞> [ _ <形容詞>]? _ <名詞> _ <前置詞>
            | <命令法の動詞> [ _ <形容詞>]? _ <名詞> _ <分詞>
            | <命令法の動詞> [ _ <形容詞>]? _ <名詞>

 分詞は using など。

スポンサード リンク

no diary

About Me

Naney Naney

Naney (なにい)です。株式会社ミクシィで SNS 事業の部長をしています。

About nDiki

nDiki1999年1月に始めたコンピュータ日誌を前身とする NaneyWeb 日記(兼パーソナルナレッジベース)です。

#nNote タグがついている記事は他の記事に比べて、より断片的・未整理・不完全なちょっとしたノートです。まだ結論に至っていない考えなども含まれます。頻繁/大幅に更新したり削除したりすることがあります。

※本サイトの内容は個人的見解であり所属組織とは関係ありません。

Other Notes

ナレッジベースアプリケーション Obsidian で書いているノートの一部を notes.naney.org で 公開しています。

月別インデックス
Process Time: 0.059054s / load averages: 0.46, 0.49, 0.59
nDiki by WATANABE Yoshimasa (Naney)
Powered by DiKicker