問題タブ [luadoc]

luaでドキュメントを生成するためのメタデータの使用に関するNormanRamseyからのコメントを読みました。

libからドキュメントを生成しようとしていますが、可能であればluadocは使用しません。

ドキュメントを生成するためのこの「メタデータ指向」の方法（使用される方法論、例、またはプログラム）について詳しく知りたいです。

他の答えも歓迎しますが、これはおそらくノーマンが他の誰よりもよく答えることができる質問です。

ありがとう！

私は現在、拡張子がxx_lua. luadoc は .lua 拡張子に対して正常に動作しており、ファイルの名前を lua 拡張子に変更してドキュメントを作成し、名前を元に戻すことができることはわかっていますが、個人的にはよりエレガントなソリューションを好みます。

luadoc に他の拡張機能を見てもらうことは可能です。電話してみた

ただし、パスにその拡張子のファイルがたくさんある場合でも、出力はありません。

明らかにフルパスでファイル名を構築している luadoc からのこれらのいくつかの (わずかに変更された) 行に注目しています。しかし、5行目で何が起こっているのかわかりません。パラメーターfilenameは「myfile.lua」のようなものかもしれません。

5 行目で何が起こるか?

LuaDocが次のようなコメントの最初の行に「---」を使用していることを私は知っています：

ただし、コメントの冒頭にこれが表示されます。

特別な意味がありますか？

VIM コマンド 'qgap' を使用して複数行のコメントに変換したい長い Lua (LuaDoc) コメントがあります。.vimrc に format-comments を含むいくつかの解決策があると思いますが、私はそれを自分で理解できませんでした。

例：

次のようになります。

質問はすべてタイトルにあります: LuaForWindows で LuaDoc を使用するには?

私の Lua インストールには luadoc_start.bat がありますが、コマンド ウィンドウが開くとすぐに閉じてしまいます。そこから、他に何ができるかわかりません。

助けはありますか？ありがとう

Suppose I have a function that returns a closure:

And then I have a variable that receives that closure:

Is there a standard way in LuaDoc to document the above construction?

luaプロジェクトのドキュメントを生成したいのですが、ファイルを上書きするたびに、単一のファイルと出力ファイルごとにLdoc生成します。docsluaindex.html

だから私の質問は、すべてのページへのリンクを持つインデックスページを使用して、プロジェクト全体のドキュメントを生成する方法です。

see タグを使用してそれを実行しようとしましたが、ドキュメント内の別の部分ではなく、別のファイルを参照するために使用できるかどうかわかりません

私はこれを使用しました：

出力はデフォルトのパスmyluainstallationpath/doc/index.htmlです。