LDoc

LDoc

LDoc c'est ...
LDoc est un générateur de documentation destiné à être compatible avec et suit ainsi le modèle défini par les différents outils Doc: --- Le résumé se termine par un point.- Une description, peut être sur plusieurs lignes.- @param p1 premier paramètre - @param p2 deuxième paramètre - @return une valeur de chaîne - @see second_fun fonction mod1.first_fun (p1, p2) end Les balises telles que see et usage sont prises en charge, et généralement les noms deles fonctions et modules peuvent être déduits du code.LDoc est conçu pour fournir de meilleurs diagnostics: si une référence @see est introuvable, le numéro de ligne de la référence est donné.LDoc connaît les modules qui n'utilisent pas module ().Ceci est important car cette fonction est devenue obsolète dans Lua 5.2.Et vous pouvez éviter d'avoir à incorporer du HTML dans les commentaires en utilisant Markdown.LDoc fonctionnera également avec le code d'extension Lua C et fournit des raccourcis pratiques.

Les catégories

Alternatives à LDoc pour Self-Hosted

Slate API Docs Generator

Slate API Docs Generator

Ardoise - belle documentation statique pour votre API.
Daux.io

Daux.io

Daux.io est un générateur de documentation qui utilise une structure de dossiers simple et des fichiers Markdown pour créer une documentation personnalisée à la volée.Il vous aide à créer une documentation attrayante d'une manière conviviale pour les développeurs.
Codex

Codex

Codex est une simple plate-forme de documentation Markdown basée sur des fichiers construite au-dessus de Laravel.Il est complètement personnalisable et simple à utiliser pour créer une belle documentation.