『Your name here問題』

symfonyで書かれたソースコードを見ていると、

@author

の部分が

Your name here

と書かれた以下のようなコードを良く目にします。

このように、

@author

が

Your name here

ばかりになる現象を、『Your name here問題』と勝手に呼んでいます。

これは、

symfony

コマンドによる生成されたファイルに自動的に

@author

が

Your name here

というコメントが生成され、プログラマが自分の名前に書き換えるのを忘れるために起こります。別に律義に書き換えなくてもプログラムの動作には関係ありませんから気にならない人ほっといても良いです。気になる人は続きをどうぞ。

『Your name here問題』の解決方法

解決方法は簡単で、以下のように

config/properties.ini

ファイルに

author

を追加するだけです。

これで、自動生成されるファイルの

@author

には正しく自分の名前が入ります。

『Kiryu Tsukimiya問題』

他の人とソースコードを共有して開発しているときには一つ注意が必要です。

properties.ini

に自分の名前を入れたものを

Subversion

のリポジトリにコミットしてしまうと、今度は

@author

が自分の名前だらけになってしまいます。自分で書いた覚えの無いファイルまで自分の名前が氾濫する事態になっり、いろんな人から身に覚えの無いファイルについて質問攻めをうける事になります。経緯は省きますが、これを『Kiryu Tsukimiya問題』と勝手に言っています。

対処方法は、

config/properties.ini

は

Subversion

のリポジトリに追加せず(ignoreする)、以下のような

config/properties.ini.in

などのテンプレートファイルをリポジトリに追加します。

あとは、チェックアウト先で

cp config/properties.ini.in config/properties.ini

として

config/properties.ini

を生成し、

##AUTHOR##

を個別に自分の名前に書き換えて使います。

---

先日社内のコードレビュー会の中で話題に出したら意外と知られていなかったのでブログのネタにさせていただきました。ほんとにトリビアですいません。m(__)m