60

TypeScript ソース コードのドキュメントを生成するためのツールはありますか? または、NaturalDocs のような一般的なものを使用する必要がありますか? ブロックコメントの推奨されるスタイルは何ですか/ドキュメントのスタンドアロンボリュームを意図したもの.

私は使用する必要があります:

///<foo>bar</foo> MSVS kind of comments?

また

/** @javadoc style comments */

多分

/*
  Something like this?
 */

インポートに使用されるため、使用するのが怖いです///。同様の方法で導入される可能性のある他の将来の機能を踏みにじりたくありません-しかし、あなたは決して知りません...

または、TypeScript から文書化された JavaScript を生成し、JavaScript ツールチェーンを使用することは可能ですか?

4

6 に答える 6

94

TypeScript *.ts ファイルから HTML API ドキュメント ページを生成する TypeDoc というツールをリリースしました。

ドキュメント ジェネレーターは TypeScript コンパイラを実行し、生成されたコンパイラ シンボルから型情報を抽出します。したがって、コメント内に追加のメタデータを含める必要はありません。

試してみたい場合は、npm からツールをインストールして実行するだけです。

npm install typedoc --global
typedoc --out path/to/documentation/ path/to/typescript/project/

TypeDoc で作成されたドキュメントがどのようなものか知りたい場合は、プロジェクトの GitHub ページにアクセスしてください。

http://typedoc.org/ | https://github.com/TypeStrong/typedoc

于 2014-06-02T20:15:56.420 に答える
23

この回答は 2013 年のものです。現在、他の (維持されている) ソリューションが存在します。その一部は、以下の回答に記載されています。

元の答え:

少し遅いかもしれませんが、この問題に遭遇した後、これを行うためのツールがまだないことがわかりました。そこで、TS コンパイラをフォークして、それを行うコードを作成しました。

v0.9.0.1 でフォークされた TypeScript コンパイラ プロジェクトは、コードに入力した JSDoc から wiki ドキュメントを生成する「--documentation」オプションを追加しました (メソッド/プロパティなどの単純な出力には必要ありません)。

https://typescript.codeplex.com/SourceControl/network/forks/EdwardNutting/TypeScriptDocumentationGeneration

.ts.wiki ファイルを生成します (新しい --wikiRemoveRoot および --wikiSourceRoot パラメータも使用する場合、その内容は CodePlex などに直接アップロードするのに適しています - fork を参照してください - 私の最初のコミットの説明)。または、コードを適応させて HTML を生成することもできます (これは比較的単純です。コンパイラ/delcrationEmitter をマングリングするという大変な作業を行いました :))

これが役に立てば幸いです（あなたまたはこの質問の将来の読者のいずれか）

エド

于 2013-08-15T22:18:34.177 に答える
7

XML Doc コメントの生成は、TypeScript 言語で提案されている問題の 1 つです。

今のところ、TypeScript ツールは JSDoc をサポートしており、TypeScript 0.8.2を発表しています。

したがって、コメントには必ず JSDoc スタイルを使用する必要があります。IntelliSense のコメントのみが必要な場合 - JSDoc を使用すると、要件が満たされます。API コンシューマーにドキュメントを提供するためにコメントが必要な場合は、コメント付きの宣言ファイル (*.d.ts) を使用する必要があります。Web 上で優れたドキュメントを生成したい場合 - TypeScript チームが XML ドキュメント コメントの生成を実装する (または手動で記述する) のを待つのは簡単だと思います。

于 2013-04-28T16:57:22.240 に答える
4

私は JavaScript にコンパイルしており、jsduck ( https://github.com/senchalabs/jsduck ) を使用して、JavaScript ファイルに基づいて API ドキュメントを生成しています。デフォルト値のないフィールド (!) を除いて、完全に機能するコメントを削除するように tsc に指示しない限り。

module example {

/**
 * My class description
 * @class example.MyClass
 */
export class MyClass {
    /**
     * Description of my property
     * @property {String} myProperty
     */
    myProperty: string = null;

    /**
     * This property will be removed in compiled JavaScript, that's why
     * this documentation will not be visible in jsduck.
     */
    willNotWork: string;

    /**
     * Description of my method
     * @method myFunction
     * @param {String} myParam
     */
    myFunction(myParam: string): void {
    }
}

} // end of module
于 2014-06-27T15:51:31.147 に答える
0

宣言 (.d.ts) ファイルから HTML ドキュメントを生成するためのツールを作成しました。JSDoc スタイルのコメントの基本的なサポートがあります。

-d -c宣言ファイルを生成し、コメントを保持するオプションを使用して、TypeScript ソース ファイルをコンパイルします。インストール後、実行できます

typescript-docs *.d.ts

標準出力に HTML ドキュメントを生成します。

出力をファイルに保存するには、次を使用します。

typescript-docs *.d.ts --output=path/to/output.html

于 2013-09-26T05:14:40.963 に答える