Образовательный проект «SnakeProject» Михаила Козлова

⇒ FreeBSD and Nix ⇐

CISCO

Voice(Asterisk\Cisco)

Microsoft

Powershell

Python

SQL\T-SQL

1С

Общая

WEB Разработка

ORACLE SQL \ JAVA

Мото

Стрельба, пневматика, оружие

Саморазвитие и психология

apiDoc

apiDoc

apiDoc - это инструмент, используемый для создания документов веб-API в стиле RESTful.
Он поддерживает большинство популярных языков программирования, таких как Python, Java, C #, Go, Dart, Java, JavaScript, PHP, Scala и т.д.
Используйте информацию аннотации, предоставленную apiDoc, в аннотации исходного кода для создания информации о документе.

Ubuntu + apiDoc

apt update && apt upgrade -y
apt install curl nodejs npm

npm -v

npm WARN using --force Recommended protections disabled.
npm idealTree:lib: sill idealTree buildDeps
Failed to install any package with ERROR Code"npm ERR! Cannot read property 'insert' of undefined"

npm config set force false
npm cache clear --force
npm config set registry https://registry.npmmirror.com

npm search apidoc
npm install apidoc -g

npm list

Запуск

apidoc -i src/ -o apidoc/ -c package.json
apidoc -i ./src/ -o ./apidoc/ -c ./package.json

Создает apiDoc всех файлов в каталоге src, используя шаблон по умолчанию, и помещает все выходные данные в каталог apidoc.

Без каких-либо параметров:
apiDoc генерирует документацию из всех файлов .cs .dart .erl .go .java .js .php .py .rb .ts в текущем каталоге (вкл . subdirs)
и записывает выходные данные в ./doc/.

Комментарии пользователей