人力検索はてな
モバイル版を表示しています。PC版はこちら
i-mobile

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

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

以下私の思考。

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

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

●質問者: MASHMASH
●カテゴリ:ウェブ制作
✍キーワード:javadoc あなた にわか クラス スッキリ
○ 状態 :終了
└ 回答数 : 1/1件

▽最新の回答へ

1 ● Kenz
●60ポイント ベストアンサー

同感です。

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

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

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

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

◎質問者からの返答

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

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

関連質問


●質問をもっと探す●



0.人力検索はてなトップ
8.このページを友達に紹介
9.このページの先頭へ
対応機種一覧
お問い合わせ
ヘルプ/お知らせ
ログイン
無料ユーザー登録
はてなトップ