私はついにホットプレートを文書化しています。私は、ドキュメンテーションは教えるべきであり、教えるべきではないと本当に信じています。Hotplate の最初の README.md を読めば、私の言いたいことがわかるでしょう。
ただし、Hotplate については、"説明" ドキュメント ("教育" 側を読んだ後にクイック リファレンスとして使用するため) が必要だと思います。
現時点では、コードにこれがあります：
/**
* Load all modules that are marked as "enabled"
*
* This function will require and register all modules in modulesFullPath
* that satisfy the `filter` regexp.
*
* modulesFullPath is actually optional: when not there, it defaults
* to the node_modules directory belonging to the current instante of Hotplate
*
* @param {filter} The regexp which will filter the modules to load
* @param {modulesFullPath} (optional) The full path of the modules to load
*
* @api public
*/
この形式を別の NodeJS プロジェクトからコピーしました。さて、質問：
「このようなものを実際のドキュメントに変える最も簡単な方法は何ですか?」
次のことを考慮してください。
- ホットプレートは、複数の小さなサブモジュールで構成されています。
- 各モジュールには、ほぼすべてを実行するサーバーの「メイン」ファイルがあります
- 各モジュールは、文書化したい 1 つ以上の「フック」を定義します (「実装されたフックのリスト」のようなもの)。
- 各モジュールはいくつかのフックを呼び出すことができます。これについては文書化したいと思います (「呼び出されたフックのリスト」のようなもの)。
では、これを行うための最も簡単で自動化された方法は何でしょうか?
メルク。