問題タブ [yuidoc]

でプロパティを定義するとしましょうObject.defineProperties()。このプロパティの型を JSDoc コメントで指定しようとすると、WebStorm から警告が表示されます。

次に例を示します。

これにより、次の WebStorm 警告が表示されます: Initializer type {get: Function} is not assignable to variable type String .

以下に切り替えると、警告は消えますが、生成されたドキュメントには「文字列」が必要であるとは記載されていません。

これを修正する方法についてのアイデアはありますか?

YUIDocが私の名前空間のドキュメントを生成していないようです。このプロジェクトはRevealing Module設計パターンを使用します

YUIdoc を使用してノード API を文書化する方法を理解するのに苦労しています。

「一見単純な」質問がたくさんあります。「ルート」と「モデル」を区別するにはどうすればよいですか? 現在、「route.foo」と「model.foo」を使用していますが、それはまったく適切ではありません。

YUIDOC を使用してドキュメントの生成を自動化しようとしていますが、Python を多用するサーバー側フレームワークがあるため、Python スクリプト内からすべてを自動化しようとしています。node コマンドを正常に実行することはできますが、npm を使用してインストールしたものを試すたびに、python は満足しません。私のプロジェクトでは virtualenv の代わりに Buildout を使用していますが、理想的にはこれらのコマンドをスタンドアロンの Python ファイルから実行できるようにしたいと考えています。

おそらく、いくつかのコードが私の状況を説明するのに役立つでしょう:

yuidoc と npm が存在するフォルダーを python の sys.path に追加しようとしましたが、うまくいきませんでした。

ps、これはこの質問と似たような質問です。

一連の Polymer Web コンポーネントを文書化しようとしています。過去にPolymer/core-docs-viewerを使用したことがありますが、YUIDocsやJSDocsのようなものほど完全ではなく、拡張可能ではありません。YUIDocs は、より大きなプロジェクト/フロントエンドとバックエンドのコードを文書化し、単一の保守可能なドキュメント ソースを作成するためのより良い選択のようです。

HTML コメント ブロック内または<script>カスタム要素のタグ内のスクリプト ブロックを解析する YUIDocs を取得する方法はありますか?

私はもう試した：

また：

これまでのところ、YUIDocs は上記のコメントで私のクラス宣言を見つけて追加していません。

任意の支援をいただければ幸いです。