クラウドワークスでエンジニアをしている八木 ( @negito6 )です。 私は最近、コメントをきちんと書くことに凝っています。コメントとは、ソースコード中に書いてコードの意図を説明したり、バージョン管理におけるコミットの説明を記述する、謂わば「注釈」のことを指します。 そこで本記事では、コメントを書くときの私なりのこだわりについて、紹介いたします。なんか長ったらしく書いています(自分でもそう思います)が、特に会社で強制しているわけではなく、今のところ私個人のポリシーです。(記事を書いた目的は、最後のほうをお読みください。) なお、バージョン管理のツールは git および GitHub の例を用いてお話しします。ご自身の環境に合わせて適宜読み替えていただけると幸いです。 何を目指して書くか 想像してみましょう。時は金曜日の21:30。オフィスに居るエンジニアは自分一人。鳴り止まないアラート