タグ

commentに関するizariuo440のブックマーク (3)

  • ネイティブと働いて分かった英語コミットメッセージの頻出動詞10つ

    ウッ ここで詰まる事は往々にしてあります. 特に急いでる時の煩わしさは甚だしいです. どうせならそれっぽい英語を使いたいのでOSSや同僚のコミットメージの語彙の出現確率を調べてみましたら、 もちろんfeatureによってコミットメッセージの付け方など数多あるものの、一定の頻出パターンは見い出せたので筆を取りました. (英語勉強しないと..) 方法 github.com/rails/railsのコミットメッセージ内における各動詞の出現確率を求め、 またOSSと仕事でのコミットメッセージの趣向も変わってくる事も勘案するため、 (仕事でDeprecateとか滅多に使わんし) 同僚に聞きつつ10つあげてみた. 以下列挙 (例は実際の同僚やOSS上でのコミットメッセージです.) Add *A to *B AをBに加える

    ネイティブと働いて分かった英語コミットメッセージの頻出動詞10つ
  • doxygen用コメントの書き方

    コメントの書き方(クラス・関数のコメント) このページの最新版は以下の場所をご覧くださいhttp://sakura-editor.wiki.sourceforge.net/DoxygenComment ソースコード中のコメントをdoxygenの 解説に反映させるためのコメントの書き方です。新規にコメントを入れる場合は以下のルールにできるだけ従うようにしてください。 関数内のコメントはこのルールに従っていただいても意味がありません ので通常のコメントで結構です。ドキュメント生成に関係するのは、 ファイル クラス メンバー関数(Inline含む) メンバー変数 グローバル変数 クラスのメンバーでない関数 定数宣言 (#define, enum) です。 doxygenで認識されるコメント スタイル doxygenではQtスタイル及びJavaDocスタイルのコメン トを認識します.コメントには要

  • particletree - Successful Strategies for Commenting Code

  • 1