ソースコードのコメントが中国語で書かれていたことから学んだ

こんにちは、kisseです。

今回は、半分愚痴ですね。笑

発端

普段、バイト先でデータ抽出の作業をやってるんですが、その際にソースコードとかデータベースのコメント欄とかを見に行く必要があるんです。
ある日、ちょっと気になることがあってソースコードを見に行ったんです。
そしたらコメントが中国語
読めない!!!

長いこと会社にいる社員さんに尋ねたところ、サービス立ち上げ時にシステムを外注していたらしく。。。
可読性とかガン無視のコードで、たまに書いてあるコメントが中国語だと、もう全然読めなかったです。

とりあえず読めるとこは読んで、微妙なとこを社員さんに確認しながら処理を追うみたいな感じでなんとか乗り切りました。



考えた

外注だから仕方ないかもだけど、日本からの依頼だともしわかってたら中国語でコメント書くのは勘弁してよー。
中国語わかる人以外メンテできないじゃん。

とか、思ってたんですが、これ自分にも言えるかも??と思いまして。
今、バイト先にはいろんな国出身のエンジニアの方がたくさんいまして、普通に日本語じゃない言語が飛び交うんですよね。笑
日本で書いたコードでも、普通に日本語苦手な人とか読むんじゃないかっていう可能性に気づいたんです。
当たり前なんですけど。

ところでプログラミングする人だと、まあなんとか英語読める人多いですよね。
ちょっと日本で使っている人が少ない言語やフレームワークを使おうとすると英語のページに飛ばされたりしてますし。

ということは、コメントを簡単な英語で書いたら、エンジニアなら読めるんじゃないかなと思いまして。
そしたら、コメントは極力英語で書いた方が後々困る人が少ないんじゃね??



ということで

中国語のコメントに遭遇した結果、英語でコメントを書いたりするようになりました。
このブログみたいな、完全に日本人しか読めないよねっていう文書なら全然日本語で書きますし、いきなりバイト先で全部英語で書いたりはしないですけど。笑

(英語でコメント書き出して気づいたんですが、ソースコードの中が全部アルファベットだと、すごいすっきりして読みやすいですね。笑)

っていう、中国語で書かれたコメントに遭遇した話でした。

最後まで読んで頂きありがとうございます!

あわせて読みたい