タグ

ブックマーク / fuyu.hatenablog.com (1)

  • 仕事でソースコードのコメントを英語で書くべきか - あなたとあなたの話がしたい

    今年の1月から新規立ち上げの開発部署でチームリーダーをやっていて、色々と「俺の考えた最強の開発手法」的なものを試しているのだけれど、その一環で、日語でなく英語でコミットメッセージやソースコードのコメントを書くという開発ルールを導入してみた。 その結果、メリットよりもデメリットが大きいことが判明して、チームとして英語で書くのをやめにしたので、その振り返りを書きたい。 英語でコメントを書くメリット Web開発の世界でグローバルな共通語として機能している 日本語入力に切り替える必要がないので、タイピング効率が良い 文法的に日語よりもロジカルに書きやすい GitHub CopilotやChatGPTのような生成AIのツールとの相性が良い RuboCopのRSpec/ContextWordingのように、英語利用を前提としたルールを提供しているLinterがある 当初このような点をメリットとして

    仕事でソースコードのコメントを英語で書くべきか - あなたとあなたの話がしたい
    petronius7
    petronius7 2023/09/18
    そりゃコメントを書くのも読むのも人間なんだから、互いに伝えられる情報量が多い物を選べばいい。日本語の場合「誰が」「何を」「どうする」をはっきり書くように心がけると曖昧さが減るはず。
  • 1