こんにちは、
今日またコメントについて話させてください。
昔、オフショア会社で1年ほどBrseとして働いたことがあります。開発はベトナムのチームと日本のチームがありました。入社したばかりの私が気づいたのは、ベトナムのチームがソースコードにあまりコメントをしていなかったことです。日本のチームも必ずしも丁寧にコメントを書いているわけではないですが、ベトナムのチームはほぼコメントがない。そして、上司と話しました。
僕 : ベトナムの方のソースコードが全くコメントしてないですが。それは前から決まったのか
上司 :いいえ、違います。コメント書かないルールなんて決まってないですよ。
当然絶対コメントしないといけないルールもないです。
僕 :そうですね。 複雑なコードも多いのですが、コメントなしソースコード理解しづらいですね。
上司 :そうなんですね。課題にしてみんなと相談しましょう。
やっぱり、みんなが最低限でもバッグ修正履歴、注意点などのコメントぐらいは必要と思いました。そして、コメントをする場合について以下のような質問がありました。
- 同じ言語で書くのか?それとも母語を使うのか?
- 同じ言語使ったら、英語、日本語どっちですか?(日本チームはベトナム語全然しらないので、ベトナム語は絶対ない)
ちょっと違うですが、昔、タイのチームと仕事をしたことがあります。その時に、日本側が日本語で、タイ側は英語でコメントしました。やっぱり母語でコメントした方が書く人には一番いいですね。そして、ちゃんとわかりやすい、誤解ないコメントができます。
日本のチームも英語読むぐらいは翻訳ツール使ったらなんとかできる。タイ側も日本語できるメンバが一人居て、それとも翻訳ツールでちゃんと日本語のコメント理解できました。
確かに翻訳もちょっと時間かかりましたが、ソースコードを全て理解できないときがあります。そういうときにコメントがあると本当に助かります。
オフショアで、言語の壁が原因でコメントについて様々な問題がありますが、
それについて、私が理解したことは:
- わかりやすいソースコードで言語の壁を乗り越えられます。
- 問題から逃げずに、コメントをしっかりと書いてください。