- 締切済み
ソースコードに編集点を書く理由
現在、派遣先でiPhoneアプリの開発をしているのですが、 上司のソースの書き方に違和感を覚えています。 アプリは既に運用しているシステムを大幅改修しての開発で、 そのためか修正もしくは追加した箇所に // (新製品名) MM/DD (氏名) start ...追加ソース... // (新製品名) MM/DD (氏名) end といったコメント文を毎回挿入されています。 (私にもそうするように言われています) 個人的にはソースがとても読みにくくなるし、有意な情報とも思えません。 SVNで管理しているので編集差分はすぐに分かりますし、上記コメントは行頭から始まるためインデントが合ったり無かったり、全体的に汚く冗長になってしまいます。 そこで質問なのですが、どうしてこのようなコメントが必要なのでしょうか? 必要ということでしたら、理由も添えていただけると有り難いです。
- みんなの回答 (3)
- 専門家の回答
みんなの回答
昔からこの国には「郷に入れば郷に従え」という言葉があります。 その会社が昔から培ってきた社内文化なのでしょうから、いくら他にツールを使っていようと従うべきでしょう。 実際のところは分かりませんが、貴方以外の人はコメント文での運用になれていて、ツールを使うよりそのほうがよっぽど早く仕事が出来ているのかも知れません。 仕事で書くプログラムは個人の趣味や小説とは違うので、職場の書式に合わせる必要があります。そうしないと全体的に見て統一性が取れなくなり、場合によっては貴方以外のプログラマが職場の決まりとは違うソースをいじることになり、非常に迷惑を被る事もあり得ます。 こんな質問サイトで愚痴ったって、本当に役にたつ回答なんて出てきやしません。質問する先は、派遣先の上司の人です。言葉の通じる相手なら、貴方が納得するまでコメント文の入れ方について相談したらいかがでしょうか。
- wormhole
- ベストアンサー率28% (1626/5665)
昔々svnなどのようなバージョン管理ソフトが使われてなかった頃(バージョン管理ソフト自体はありましたが「それ何?」という会社も多かったです)に、そうしていたからというだけでは? それをすすんで行ってる人らは「変更点がわかりやすい」という事で行って(またはそう教えられて)、 それをずっと引き継いでやってるんじゃないかと。
- IDii24
- ベストアンサー率24% (1597/6506)
iPhoneだからでは?つまり計画的にソースを管理するなんてのは頭に入れてないのでしょう。短命のアプリに関してはそんなものです。10年使うなら別管理すべきです。 当然これらはライティングの標準として世界的に決められた事で、ソースの中に余計な命令は書かない。コメントは短く。 まあコメント込みでアプリの容量ですからね。テキストでいっぱいコメントにソースを書けばバイナリエディターで開けば見えることもありますから。それも問題ですよね。 iPhoneのアプリ程度なら、まあいいかってところだと思います。