1

次のアーキテクチャで、jsduck を使用してオーバーライド フォルダー内のクラスをドキュメント化する方法。

 MyApp
 -app
 -overrides
 -plugins
 -resources
 -...

アプリフォルダー内のクラスを文書化することしかできないようです。私のjsduckドキュメントでは、フォルダー「app」と「Ext」のみが表示されます

また、フォルダ オーバーライド内のファイルへのリンクを作成する方法を教えてください。次のオプションは機能しません。

{@link overrides.file file}
{@link MyApp.overrides.file file}

編集:

MyApp
-app 
 . panel
   . panel.MyController.js
     . onPrintButtonMethod (overrides.printPanel.js)
-overrides
 . overrides.printPanel.js
-plugins
-resources
-...

次の解決策を試しましたが、クラス「override.PrintPanel」への参照がjsduckに記載されていないようです。このケースを文書化する最善の方法は何ですか?

/**
*@class myapp.panel.MyController
*@class overrides.PrintPanel 
*
*@override myapp.panel.MyController
*@override Ext.panel.Panel
*/
Ext.define('overrides.PrintPanel', {
  override: 'Ext.panel.Panel',
  …
});

jsduck に表示されるフォルダーとファイル:

- MyApp
  -app
   - store
   - ux
   - view
     - panel
       -panel.MyController.js
- Ext
  -Microloader
  global
4

1 に答える 1

1

@override タグ docsを見てください。

ソースファイルへの sに関して@linkは、これらは JSDuck ではサポートされていません。それらは実際には必要ありませんが、文書化されたメソッド/クラス/etc は自動的にソース ファイルにリンクします。本当に必要な場合は、ハードコーディングされた Markdown または HTML リンクを使用できます。

于 2016-03-10T07:07:37.047 に答える