一般的な関数の命名則

命名の方針

• 英語として正しい名前である
• 関数は何か一連の処理を行うためのモノである

事を考えると、関数の命名は以下の形式が好ましい。

(動詞) - (目的語) - (付帯条件) - (動詞を修飾する副詞)

例としては

get_active_element_with_id_async

名前の付け方

とりあえず、以下の事に気を付けると良い

• 関数が行っている処理をもれなく書く
• アバウトな表現は避ける
• 正しい英語で書く

関数名の目安として、関数名をそのまま英語から日本語に直した時に意味が分かり、実際の関数の動作とあっていればいいと考える。 関数に Doxygen などで使えるコメントをつけるのがおススメ。ドキュメントも整理できて、↑の関数名の確認もできるので。

コメントを英語に翻訳する

• 関数に対して、何をしているのか？を日本語のコメントとして書き記す。
• 関数が行っていること全てを、正確かつ誤解のない様に書く。
• その日本語のコメントを英訳する。
• この時に出来上がった英語は『関数の動作を、全て、正確かつ誤解のない様に』書き記しているはずなので、関数名と一致しているはず。

と言う理論。

ドキュメントコメントを付ける

/// <summary>
/// <para>ID を用いてアクティブな Element を非同期に取得します</para>
/// </summary>
/// <param name="id">ID</param>
Task<Element> GetActiveElementWithIdAsync(int id)

状態を確認する関数

目的	形式
既に完了しているか？	has-(動作を表す動詞の過去分詞形)
今、その状態か？	is-(状態を表す形容詞)
ある動作が可能か？	can-(動作を表す動詞)