Size: a a a

DocOps-сообщество

2019 August 22

RG

Ramil G in DocOps-сообщество
Nick Volynkin
Да, и эти технологии довольно быстро меняются. Практически, мы открываем портал в ад (зачеркнуто) фронтенд и девопс. И оттуда на нас лезет всякое вроде GraphQL. ))
ну если обсуждать чисто писательскую деятельность, то в https://t.me/technicalwriters
источник

DM

Dina M. in DocOps-сообщество
Да там те же страшные непонятные слова :) Контингент-то пересекается, и прилично
источник

ЕГ

Егор Гуща in DocOps-сообщество
Ребят, можете скинуть статью/статьи на то как вообще следует писать документацию к библиотеке (js) ?
источник
2019 August 23

L

Lex in DocOps-сообщество
У яндекса кажется были доклады с Гипербатона о том как они документируют свои js библиотеки или апишечки.
источник

L

Lex in DocOps-сообщество
Посмотрите также на инструмент jsdoc
источник

FM

Fox Mulder in DocOps-сообщество
Lex
У яндекса кажется были доклады с Гипербатона о том как они документируют свои js библиотеки или апишечки.
Да, не только с гипера, но и с обычных батонов.
источник

v

vladimir in DocOps-сообщество
всем привет.
вопрос не совсем напрямую связан с документацией, но может кто знает: есть ли линтеры и как их найти, которые проверяют наличие комментариев к коду?
источник

НН

Нац Нац in DocOps-сообщество
vladimir
всем привет.
вопрос не совсем напрямую связан с документацией, но может кто знает: есть ли линтеры и как их найти, которые проверяют наличие комментариев к коду?
зависит от кода. jsdoc и иже с ними
источник

v

vladimir in DocOps-сообщество
спасибо, буду изучать! 👍
источник

НН

Нац Нац in DocOps-сообщество
vladimir
спасибо, буду изучать! 👍
На всякий случай еще кину обычный линтер текста, его можно настроить на комментарии. Это если вас интересует именно >качество< комментариев
источник

v

vladimir in DocOps-сообщество
у меня задача - формирование внутренней документации для разработчиков из комментариев к коду. вот хотелось бы какой-то инструмент, который бы не давал релизить, если нет комментариев к коду...
источник

НН

Нац Нац in DocOps-сообщество
Хм.. могу представить, что можно не дать закомиттить код без коммента к самому коммиту, а вот внутри это уже потяжелее, даже не знаю, поможет ли в этом jsdoc (если у вас ваще жабоскрипт или тайпскрипт)
источник

v

vladimir in DocOps-сообщество
ts + c#
источник

НН

Нац Нац in DocOps-сообщество
Я слаб в этой теме, но мне кажется, что можно небольшой скрипт написать, который перед коммитом\релизом запустит проверку tsdoc'ом и в зависимости от выхлопа самого tsdoc даст или не даст релизнуться\закомиттится. Буду рад, если кто-то разжует поподробнее про это
источник

SR

Stas Rychkov in DocOps-сообщество
vladimir
ts + c#
Привет. Для Явы, наверное Sonar. С шарпом не знаю. А Checkstyle смотрели? Он в сонаре есть.
источник

v

vladimir in DocOps-сообщество
Stas Rychkov
Привет. Для Явы, наверное Sonar. С шарпом не знаю. А Checkstyle смотрели? Он в сонаре есть.
спасибо, буду смотреть сейчас 👍
источник

SR

Stas Rychkov in DocOps-сообщество
Ещё было что-то в JavaDoc'е. Но вот небось это не пришей кобыле хвост в вашем случае.
источник

НН

Нац Нац in DocOps-сообщество
там же ts, не жава
источник

v

vladimir in DocOps-сообщество
А Checkstyle смотрели?

Checkstyle - инструмент разработки, помогающий программистам писать код Java 😔
источник

SR

Stas Rychkov in DocOps-сообщество
vladimir
А Checkstyle смотрели?

Checkstyle - инструмент разработки, помогающий программистам писать код Java 😔
Ага, значит никакого шарпа не появилось. Пардон.
источник