個別案件でクラスドキュメント化ツール(JavaDoc/PHPDocumenter/PHPDoc)を使うとかえってわかりづらいと思うのですが、同じように思う方、あなたが気づいた理由を教えてください。建設的なら反論もどうぞ。


理想論はおいといて現場の実感を踏まえてお願いします。

以下私の思考。

そもそもドキュメントツールの違和感(JavaDoc/PHPDocumenter/PHPDoc)は
・プログラム言語のヘルプファイルのようなドキュメントがクラスと関数単位で出来る。
・フレームワークや汎用ツールやライブラリのヘルプに作成に使うならならよいが、個別案件のドキュメントとしては人を突き放しすぎ?

・個別案件では意図や経緯や連携の説明が重要で、汎用的に関数を説明すると逆にわかりづらい。
・動きを説明するより関数の説明書になり全体像を忘れる。
 >関数単位の動きはわかるが全体として何かわからない。
・スッキリ分割されたプログラム言語やフレームワークのプログラムと比べ
個別案件のプログラムは構成が絡み合っており、部分を強調しても理解しにくい。。

回答の条件
  • URL必須
  • 1人2回まで
  • 13歳以上
  • 登録:2010/05/19 19:15:10
  • 終了:2010/05/20 10:14:26

ベストアンサー

id:kenz-firespeed No.1

Kenz回答回数104ベストアンサー獲得回数32010/05/19 19:30:05

ポイント60pt

同感です。

私はソースコードに余分なコメントが入ることで肝心のソースコードの可読性が下がってしまうように思います。

あと、ドキュメントを記載することに思考が持って行かれることで思考の分断が起きるのも嫌です。

再利用性が少ないコードに関しては関数名やクラス名を自己説明的にすることで対応可能だと思っています。

http://ja.wikipedia.org/wiki/DRY

id:MASHMASH

ですよねぇ。再利用性が少ないものもいっぱいありますよね。

現場ではどうも「なんでもかんでも/タダだから/オープンソースだから」とツールを詰め込みがちで、ありゃーと思っています。

2010/05/19 22:57:26

コメントはまだありません

この質問への反応(ブックマークコメント)

「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。

これ以上回答リクエストを送信することはできません。制限について

絞り込み :
はてなココの「ともだち」を表示します。
回答リクエストを送信したユーザーはいません