1

ヘイルスタック!!

同僚のためにフレームワークを開発していますが、それを文書化するのに苦労しています。
プライベート メンバーを省略した ASDocs (@private ディレクティブがなくても)。

それを強制的に文書化する方法はありますか??

4

1 に答える 1

3

これはASDocsのドキュメントからのものです：

デフォルトでは、ASDoc ツールは、ASDoc コメントを省略した場合でも、ActionScript クラス内のすべての public 要素と protected 要素の出力を生成します。ASDoc が要素を無視するようにするには、コメント内の任意の場所に @private タグを含む ASDoc コメントを挿入します。ASDoc コメントには、出力から除外される @private タグとともに追加のテキストを含めることができます。

「すべてのパブリックおよび保護された要素に対して」と明示的に述べていますが、これは API ドキュメントにとって意味があります。プライベート メンバーはクラスの外部からアクセスできないため、非表示のままです。

この回答も参照してください: Documenting private members with ASDoc

于 2011-02-16T17:11:19.867 に答える