ソースコードに埋め込まれたコメントから文書を生成するツールとして,DoxygenとSphinx+Breatheについて検討し,Doxygen単独での利用が妥当と結論づけた。そのことについてメモしておく。 一連の考察は以下でまとめたツイートがベースとなっている。 Doxygen vs. Sphinx+Breathe – Togetterまとめ Introductionソフトウェアを開発していると,そのソフトのクラスの構成や使い方,概念などが複雑になってくることがある。また,会社など複数人で開発を行っていると,新しく参加する人のためであったり,数年後に忘れた時のために,APIの説明文書(API文書)があるととても役に立つ。 しかし,こうしたAPI文書を作成する労力は無視できない。また以下の点も文書整備の妨げとなるだろう。 ソフトウェアの更新。 文書整備の優先度の低さ。 こうした問題があるため,
![Doxygen vs. Sphinx+Breathe](https://cdn-ak-scissors.b.st-hatena.com/image/square/771bbe42004f937d1a60625d2fa4effa85c3ae1c/height=288;version=1;width=512/https%3A%2F%2Fi0.wp.com%2Fsenooken.jp%2Fasset%2Flogo%2Fcropped-star-color-512x512-1.png%3Ffit%3D512%252C512%26ssl%3D1)