Javaのソースコードに特定の表記にしたがってコメントを書いておくと、javadocユーティリティを使ってクラス関係やコメント、APIマニュアルを生成することができる。開発で使われるAPIリファレンスの多くはこの方法で生成されたものだ。 同様にしてJavaソースコードをAPIマニュアルのように加工するソフトウェアにMavenで採用されているJXRなどをあげることができる。本稿ではこれに近いソフトウェアのひとつとして「Sorcerer」を紹介したい。19日(米国時間)に公開されたできたてほやほやのプロジェクトで、まだ開発がはじまって間もないが今後の展開が大いに期待できる。 図.1 毎度お世話になっているJDK 1.5 APIリファレンス 図.2 Sorcererで加工されたリッチなJavaソースコードリファレンス
Natural Docs lets you document code written in any of 25 programming languages, plus it can be easily extended for more so whatever you use, it can too. And if your project uses multiple languages, no problem! It will all be included in the same set of documentation. Natural Docs also speaks your other language... English! Its comments are designed to be very natural and readable so they're jus
This page has moved to https://www.doxygen.nl/. Please update your bookmarks / links.
はじめに プログラマには、ドキュメント、とくにプログラムの内部仕様書を書くのが苦手、 という人が多い。 その理由は明らかであって、そもそも、ソースコードに (バグも含めて)*1 すべての仕様が子細もらさず書かれているのに、なぜ、さらにそれと独立した仕様書が必要なのかと、 (半ば本気で) 思ってしまうからである。 ソースコードと独立にメンテナンスをしなければならないような仕様書は、 いずれソースコードと整合性が取れなくなって、無意味ならまだしも、 かえって害をなす存在となり果てることもある、ということを、 彼らは経験的に理解しているのである。 (*1) Ruby の作者である、まつもとゆきひろ氏は、 その著者『オブジェクト指向スクリプト言語 Ruby』の中の「付録C Ruby 用語集」で、 次のように書いている: ドキュメント まつもとの苦手なもの。彼は普段から「ソースがドキュメントだ。
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く