質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.78%

業界の悪習

解決済

回答 2

投稿

  • 評価
  • クリップ 2
  • VIEW 1,239

score 3642

私が参加しているプロジェクトではこれまで改訂履歴に関するルールは存在しなかったのですが、これから改修箇所はコメントで修正履歴を残すことが義務付けられることになってしまいました。
// yyyy/mm/dd daresore MOD Start
//// yyyy/mm/dd daresore DEL Start
//// // hogeMethod(param2);
//// yyyy/mm/dd daresore DEL End
// yyyy/mm/dd daresore daresore DEL Start
// // fugaMethod("");
// yyyy/mm/dd daresore daresore DEL End
// yyyy/mm/dd daresore irdaresoreof MOD End
hogeMethod(param);

バージョン管理システムを利用しているのにコメントで修正履歴を残すことは悪習だと思うのですが、皆さんはどう思われますか?
また、もうこんな悪習は嫌だ!って話ありますか?
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

+2

履歴コメントが入っているコードを引き継いで自分がコーディングルールを決められる立場になったものは、新しい修正時には履歴を入れないようにしています。

1メソッドは長くても20行とかにしていた場合、コードが履歴に埋もれてしまうとそれが守られなくなりますね。
コードの単位を短くするのは、その単位で全体を眺めて処理を把握することを容易にするためだと思いますので、コードが履歴に埋もれてしまうと全体を把握する際にノイズが乗ってしまいます。

この辺のコメントの入れ方を含むコーディングルールは、多くの有名なコーディングスタイルでは否定の傾向があるかと思いますし、個人的には、履歴コメントがあるとコードの品質は低下すると思います。


もし履歴コメントを入れる提案が出たとしたら、上記理由と併せてバージョン管理システムで履歴を確認する手順を確立させて反論し、断固阻止します。


でも、バージョン管理システムをつかいこなせない(しようとしない)メンバーで開発する場合は仕方ないかもしれませんね。



その他の悪習もたくさんありますが、その中でも履歴コメントは最悪の部類ですね...

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2014/11/22 10:38

    うちで履歴を残せと言い出したのが顔も知らない、コードも書かない、コードを読むかも怪しいお偉いさん・・・

    後は何でもExcelで管理しようとするのも悪習。

    キャンセル

  • 2014/11/22 10:50

    「素人が口を出すな!」って言いたいところですね。

    Excelは、構造を表す目的には向いていないと思いますが、1ファイルに複数の書類(シート)をバインドできるのは便利なんですよね。
    何もかにも全部Excelでやるのは反対ですね。

    キャンセル

  • 2014/11/22 14:18

    1ファイルに複数の書類(シート)をバインドできるのは便利なんですがシートのタブが満杯になった設計書の恐ろしいことと言ったら。
    こういうのに限って中身が空だったり、一見書いてある風に見えて役に立たないなどよくあると思います。

    キャンセル

+1

ソースコードが見づらくなるのは同意しますが、
あなたの利用しているバージョン管理システムで更新履歴は見やすいのでしょうか?

現状のバージョン管理システムを用いてファイルの更新履歴を見る方法を周知させ、
それが使いやすいことを納得させた上で、
改めて更新履歴を消す提案をするべきです。

更新履歴を見るために長々と複雑なコマンドを打たないといけなかったりすると、反対するユーザも出てくるでしょう。
いかに「バージョン管理のほうが見やすいだろ!?」ってのを訴えられるかが重要だと思います。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2014/11/22 14:13

    何らかの書類の形ではなくソースの現物を見たいようで、そのソースは試験を通したもの(コメントも含めて一致する)ではなくてはいけないようです。

    今まで同じようにやってきたからこれからも同じようにやるという思考停止です。

    キャンセル

  • 2014/11/23 18:34

    業務改善をする余地がもしあるのであれば、複数の改善案を用意して利点と欠点を並べて説明するしかないですかね…

    キャンセル

  • 2014/11/23 19:09

    改善案を提出することが出来る範囲では改善進められているのですが…
    ・MarkDownを使った資料作成
    ・Jekins導入
    ・SubversionからGitへの移行
    ・GitLab導入(準備中)

    なんとか説明してみようと思います。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.78%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る