仕様書と同じ言語でコーディングをすること

件名:メソッドや変数に日本語を採用したい

メソッドや変数に日本語を採用したい – Insider.NET

最近、@ITにこんなスレッドが浮かんできたので、過去にもブログで書いていますが、

もうちょっと書いてみます。

以前書いたとおり

■[IT雑感]日本語でコーディング

最近、開き直ったように日本語でコーディングしている。

クラス名、メソッド名等も含めてである。

NAL-6295の舌先三寸 – 今やっと山の麓に辿り着いたのだと気づいた

仕様書とコードは同じ言語で書いたほうが

開発時の効率もその後の保守性もあがる。

というのが、私の主張ですが、

発想は簡単です。

・メソッドのヘッダコメントに日本語を使うなら、

それをメソッド名にすれば良いのにと考えます。

・処理に記述するコメントに日本語で記述するなら、

そのコメントに現れる日本語の単語を、

変数名にしたり関数名にしたりすればよいのにと考えます。

・保守の度に記述された処理とコメントの両方を

メンテナンスしなくてはいけないとしたら、

そこにはヒューマンエラーがひそんでいそうです。

(実際にコメントに騙された事が多々あります。)

・英語と日本語の対応辞書を作るなんてめんどくさいし、

 それこそヒューマンエラーを招きそうです。

 

また、実績として、

・開発したことない新人でも、構成を理解してくれました。

 簡単な修正もやって貰えました。

・一般的なレベルの他人に保守して貰ったら、

 実績より早く修正されました。

・1年前の自分は他人ですが、1年前の自分を理解できました。

・IMEのON/OFFは思ったよりめんどくさくありませんでした。

・最初はメンバもとまどいましたが、少したつと分かり易いという

 利点に気づきました。

webアプリケーションの開発をしていますが、

オブジェクト名は別に日本語でも問題ありませんし、

SEOを考えないので良い社内システムであれば、

URLも日本語で定義しておいて、URLEncodeすれば良いと思います。

勿論、仕様書そしてエンドユーザの第1言語が日本語だったらの話ですが。

Share