CやC++, Java その他諸々の言語でかかれたソースを解析してクラス構造などを図表化したり、注釈からドキュメントを生成してくれたりするツールに doxygen というものがある。
このツールのおかげで、ドキュメンテーションの手間は確かに減った。
しかし、「他人にわかるように」ドキュメントを書く、などという機能はもちろん無いので、それはドキュメントの文面となる注釈を書く人自身に「他人にわかる」説明ができなければならないのは変わらないｗ
…まぁ、「書いただけ」のドキュメントに終わらんようにせねばなぁｗ
「あの意味不明の説明が、最後の一つとは限らない…
いつまた第二、第三の意味不明注釈が(以下略)」
などということになると、コード本体よりも注釈の校正に走り回ることになりかねないという…
