ソースコード上の主語は誰か、という話
ふとTwitterで投げたらリプライたくさんきた
これ素朴な質問なんだけど、ソースコードで英語でコメント書くとき、守護はIなのかWeなのかコードそのもので受動態で書くのか、どっちなの
— 性格は糞 (@mizchi) 2013, 9月 23
@mizchi 一行目は主語無し(命令形)、長い説明をつける場合は 1.言い訳がましいコメントは I を主語に 2. 誰かと合意済みの事柄は We を主語に 3. 仕様に沿う振る舞いに変更する場合は It should be ~ などコード自体が主語であるように、と書いてる
— Kensuke Nagae (@kyanny) 2013, 9月 23
@mizchi "add …": このコードは…を足します、"added …" このコードは…で足されました、"adding …" このコードは…を足しています
— 中村氏 (@r7kamura) 2013, 9月 23
@mizchi みたいな感じでaddedとかはweじゃないですか
— 中村氏 (@r7kamura) 2013, 9月 23
@mizchi 何ヶ月か先の自分も他人という言葉に従って、基本的にyouにしてますね。you should 〜 とか
— しそ (@sisomoti) 2013, 9月 23
@r7kamura @mizchi その感じだと全部意味上の主語はコード自体で"added"は"be added"の省略形な気がします
— 瀬戸内着床 (@Mekajiki) 2013, 9月 23
自分はgitのコミットコメントはIのつもりで書いてた
— 性格は糞 (@mizchi) 2013, 9月 23
@kyanny この場合ソースコードが誰のものか?という外的要因に起因していく気がしそうですね(アジャイル or not アジャイル、受託 or 自社開発で)
— 性格は糞 (@mizchi) 2013, 9月 23
@mizchi コード中で「こういう事情があるからこうしたほうがいい」ってときは "we should ..." で、 API なんかを「こう使いなさい」は "you should ..." になる
— ともくんのママ (@uasi) 2013, 9月 23