IC
Size: a a a
2021 February 17
VS
Это API Vue, не API для Vue
VS
Что вы подразумеваете под "API для Vue"?
IC
Я документирую приложение, которое использует похожие апи. Сделано на Vue
VS
Ivan Cheban
Вадим, у меня п. 2. Описываю методы апи: что он делает, какие параметры могут быть.
И, судя по скрину, вы хотите задокументировать какой-то модуль под Vue, написанный разработчиками, похожим с официальной докой образом, верно?
IC
В целом да. Пока не весь модуль, а только конкретные методы, которые смогут использовать разработчики клиентов при использовании нашего фреймворка.
IC
Например вытянуть данные из джейсона
IC
getRaw метод
IC
Я так понимаю, что если перед методом добавить комментарий по стандарту TypeDoc, то он потом может парсить файлы с кодом и выдавать документацию
VS
UI часть у фреймворка есть?
VS
В целом, если у плагина есть UI, привязка событий к нему и т.д., рекомендую обратить внимание на такие вещи
https://github.com/Kocal/jsdoc-vuejs
https://vue-styleguidist.github.io/docs/Documenting.html
https://github.com/Kocal/jsdoc-vuejs
https://vue-styleguidist.github.io/docs/Documenting.html
IC
Вадим, спасибо! Буду пробовать. Пока TypeDoc у меня запустился, документация сгенерировалась. Буду говорить насчет комментов разработчиков ))
2021 February 19
KC
Всем привет! Нуждаюсь в рекомендациях. У меня есть файлик .sql с описанием таблиц и полей, как из него быстро и удобно сверстать файлик — перевести в любой удобочитаемы вид?
S
sql сам по себе довольно читаемый
KV
Всем привет! Нуждаюсь в рекомендациях. У меня есть файлик .sql с описанием таблиц и полей, как из него быстро и удобно сверстать файлик — перевести в любой удобочитаемы вид?
Я как обычно:
1. Импортнуть в DBML через https://dbdiagram.io/home
2. Скормить DBML Фолианту: https://foliant-docs.github.io/docs/preprocessors/dbmldoc/
1. Импортнуть в DBML через https://dbdiagram.io/home
2. Скормить DBML Фолианту: https://foliant-docs.github.io/docs/preprocessors/dbmldoc/
NV
Я как обычно:
1. Импортнуть в DBML через https://dbdiagram.io/home
2. Скормить DBML Фолианту: https://foliant-docs.github.io/docs/preprocessors/dbmldoc/
1. Импортнуть в DBML через https://dbdiagram.io/home
2. Скормить DBML Фолианту: https://foliant-docs.github.io/docs/preprocessors/dbmldoc/
Это шедевр!
KC
sql сам по себе довольно читаемый
я согласна
но, например, юристы точно не будут его открывать и разбираться)
но, например, юристы точно не будут его открывать и разбираться)
S
а зачем юристам схема БД ?
KC
а зачем юристам схема БД ?
как пример — соблюдение закона о персональных данных
S
закон на схему каким образом мэпится ? Кроме шифрации пароля