整理された文書をあっという間に生成
Specadorは、ソースコードから正確なドキュメントを自動生成するツールです.
- 整理された効果的な文書の作成
- 文書化プロセスの自動化
- 時間を節約し、メンテナンスコストを削減
- より高品質な開発を保証
Specadorを使用すると、設計および検証エンジニアは、適切で整理されたドキュメントを簡単に作成し、維持することができます。バッチモード（コマンドライン）で動作し、専用の言語パーサーを用いてHTMLまたはPDFを自動生成します。
Specadorを使用すれば、コメントのないソースコードからでも、設計や検証環境に関する意味のあるドキュメントを生成することができます。これは、Specadorがコードをコンパイルし、プロジェクト構造を理解するためです。そのため、例えばクロスリンクされたクラス継承ツリー、設計階層、ダイアグラム等を生成できます。
Specadorは、既存の開発フローに簡単に統合できます。ドキュメントは常にソースコードと同期しているため、ダイアグラムの管理や、ポートや関数の引数リストを現在のバージョンに合わせて更新するといった、手作業では問題が発生しやすい作業を自動化できます。
Specadorは、IPプロバイダや社内向けIPを開発しているエンジニアにとって、IPのパッケージングに特に有効です。
SpecadorはHTMLやPDF出力の読みやすさを向上させるために、Markdown構文を認識し、ドキュメントのコメントを希望に応じた書式にすることができます。
特長的な機能
- 言語の認識：ドキュメントは、関係情報と構造情報の両方を含む、言語固有の概念で構成されています。例えば、パッケージ、クラス、エンティティ、モジュール、構造体などの専用カテゴリがあり、クラスの継承、設計階層、エンティティ・アーキテクチャを簡単に調べることができます。
- クロスリンクされたドキュメント：ユーザは、関数のドキュメントからその引数の1つに、またはモジュールの定義からそのサブモジュールの1つに簡単にジャンプすることができます。
- ハイパーリンク・ダイアグラム：Specadorは、ブロック図や回路図（スケマ）、または継承図やコラボレーションUMLクラス図などのダイアグラムを自動生成します。ダイアグラムはハイパーリンクされているため、ダイアグラム内のクラスをクリックすると、そのクラスがドキュメント化されている章にジャンプしたり、スケマティック内のサブモジュールをクリックすると、サブモジュールの章にジャンプしたりすることができます。
- ビットフィールド図： Specadorはデータ型またはUVMレジスタ・コンフィグレーション・メソッドを解析することにより、ビットフィールド図を自動生成します。
- 波形図：Specadorは、一般的なオープンソースのWaveDromフォーマットを使用して、指定された波形を自動生成します。
- カスタマイズされたダイアグラム：Specadorは、ディレクティブをコメントで受け取り、外部スクリプト/ツールに与えて処理し、生成された結果をドキュメントに含めることができます。