TypeScript: TypeDoc で Class コメントが出てこないと思ったら、無関係な tag を設定していたからだった

背景

TypeScript で TypeDoc を利用しようと試行してたところ全然コメントが出ない！という問題にであった

が・・知ってれば阿保らしいミスだと思います。ということで記録まで

原因

以下のように、class に対して、module タグをつけてたのが原因

ダメな例

/**
 * くらす
 * 
 * @class SampleClass
 * @class SampleClass2
 * @module SampleModule
 */
export class SampleClass {
    public Name = "Sample";

    private Nickname = "Simple";
}

二重定義したら、二重に出るだけ

最初はこれかと思ったら・・二重定義しても問題なかった

あとがき

付けていい場所、悪い場所、の分類はまだ出来てないけど・・
その前に、TypeDoc vs TSDoc という悩みの種が出てきたのが頭痛の種・・