エンベデッドシステムスペシャリスト 2022年午前2 問24

問題文

ドキュメンテーションジェネレーターの説明として、適切なものはどれか。

🖊️ 解答を隠して解いてみる

ア：HTML、CSSなどのリソースを読み込んで、画面などに描画又は表示するソフトウェアである。

イ：ソースコード中にある、フォーマットに従って記述したコメント文などから、プログラムのドキュメントを生成するソフトウェアである。（正解）

ウ：動的にWebページを生成するために、文書のテンプレートと埋込み入力データを合成して出力するソフトウェアである。

エ：文書構造がマーク付けされたテキストファイルを読み込んで、印刷可能なドキュメントを組版するソフトウェアである。

🔒 解説は解答すると表示されます

ドキュメンテーションジェネレーターは、ソースコードに書かれたコメントや注釈を読み取り、プログラムの仕様や使い方を説明するドキュメントを自動生成するソフトウェアです。

この説明に当てはまるのは、イです。たとえば、ソースコード中のクラスや関数の説明を、定められた形式でコメントに記述しておくと、API仕様書などを生成できます。

コメントを表示するだけの機能だと思う：単にコメントを画面に表示するのではなく、コメントなどを材料として、仕様書やAPIドキュメントを生成します。
HTMLを扱うソフトウェアはすべて同じだと思う：HTMLを画面に表示するブラウザー、Webページを生成する仕組み、ソースコードから説明文書を生成する仕組みは、それぞれ役割が異なります。
ソースコードそのものをドキュメントに変換すると思う：生成されるのは主に、コメントや注釈を基にした説明文書です。

ドキュメンテーションジェネレーターを利用すると、ソースコードの変更に合わせて説明文書も更新しやすくなります。代表例として、JavaのAPIドキュメントを生成するJavadocがあります。コメントの書式を統一しておくと、クラスや関数の説明、引数、戻り値などを整理したドキュメントを作成できます。

ドキュメントには何が含まれますか？
APIの仕様、関数の役割、引数や戻り値の説明、使用例などが含まれます。

コメントを書けば、どのような内容でも自動で文書化できますか？
生成ツールが認識できる形式でコメントや注釈を記述する必要があります。コメントの内容が不十分であれば、生成されるドキュメントも不十分になります。

Webブラウザーもドキュメンテーションジェネレーターですか？
いいえ。ブラウザーはWebページを読み込んで画面に表示するソフトウェアであり、ソースコードからプログラムのドキュメントを生成するものではありません。

関連キーワード: Javadoc、APIドキュメント、ソースコードコメント、テンプレートエンジン、組版ソフトウェア

\ せっかくなら /

エンベデッドシステムスペシャリストを
クイズ形式で学習しませんか？

すぐに利用可能！