パスワードを忘れた? アカウント作成
この議論は賞味期限が切れたので、アーカイブ化されています。 新たにコメントを付けることはできません。

プログラマーにドキュメントを書かせるには?」記事へのコメント

  • きちんとドキュメントをまとめることができるプログラマのコードには、
    そもそもドキュメントは必要ない、ような気がする。

    #経験則では、ないです。

    • by Anonymous Coward on 2012年01月17日 12時52分 (#2081939)
      経験則から言うと
      ・外部仕様やデザインポリシーはメモ程度で良いのでドキュメント化しとくべき、後になると自分でも何でこんなことをやったのか目的が理解できなくなることがある。
      ・プログラムの内部仕様をドキュメント化するのは時間の無駄、そんなものを書く時間があるのならば綺麗な読みやすいコードを書くのに時間をかけた方が何倍もまし。
      ・読みやすいコードが書けないやつに、ドキュメントを書くなんてそもそも無理。
      親コメント
      • コードとドキュメントを読んでいって、どちらも読みやすい人と、
        どちらも読みにくい人のどちらかしか巡り合ったことのない私は不運でしょうか?

        後者に限って、「ドキュメントなんて…」と言うわ、口頭説明も嫌がるわ、だったり。

        親コメント
      • by Anonymous Coward

        > 読みやすいコードが書けないやつに、ドキュメントを書くなんてそもそも無理。

        ものすごく同意できます。
        ドキュメントが書けないので不要論を展開する輩が多い。
        彼らはドキュメントに記述できる設計思想がないままコーディングしているのでしょうね。
        だからコーディング前には書けないし、コーディング終了後も明記できる設計がない。

        #突貫(特攻)作業中に限り、脳内ドキュメントを許可する。(大本営特別指令)

      • by Anonymous Coward

        >後になると自分でも何でこんなことをやったのか目的が理解できなくなることがある

        その補足のために前のコードをコメントアウトして残したりしてたけど、上司から削除しろと言われたりしたっけ。

        • by Anonymous Coward on 2012年01月17日 23時06分 (#2082360)
          そういうのはバージョン管理システムのコミットログに書くべき事であって、コード上に残す物じゃ無いよ。
          親コメント
          • by Anonymous Coward

            内容によるんじゃない?
            「変数がvolatileなのは・・・からアクセスされる為」
            とかコミットログに書いてあったら大変。

弘法筆を選ばず、アレゲはキーボードを選ぶ -- アレゲ研究家

処理中...