Cómo utilizar apidoc para escribir documentos de interfaz

1) Es inconveniente escribir. Cada vez que agrega una nueva interfaz, debe copiar la última interfaz y luego modificarla. Algunas de las mismas partes no se pueden reutilizar. Si hay demasiadas interfaces, el documento se volverá muy largo y, a menudo, será necesario cambiar el formato. equilibrado. 2) La publicación es inconveniente. Una vez actualizado el documento, es necesario enviarlo a los socios que lo necesiten. En otras palabras, aunque usar Git para la administración es más conveniente extraer, debido al formato del archivo, es inconveniente comparar las diferencias entre dos envíos.

Debido a estos problemas, decidimos buscar una forma más elegante y eficiente de escribir documentación. Después de la comparación, encontramos apidoc, que puede resolver los problemas anteriores. apidoc utiliza un método similar a escribir comentarios de código para escribir documentación y admite la escritura de documentación en varios idiomas. El documento final generado se publica en forma de página web, que es cómoda y fácil de leer. La siguiente es una breve introducción sobre cómo utilizar apidoc para escribir documentos.

1. Instale node

Dado que apidoc se basa en la herramienta de administración de paquetes de Node.js npm para su instalación, debe instalar node.js antes de instalar apidoc (npm funcionará con el nodo instalado juntos). Puede consultar el tutorial de instalación aquí.

2. Instale apidoc

Después de instalar npm, puede instalar apidoc. Escribe en la línea de comando