Публикации по теме 'documentation'


Обновления документации по воспроизведению
Мы рады поделиться значительными улучшениями в документации Replay! Миссия Replay — сделать программное обеспечение более понятным, доступным и инклюзивным. Все начинается с того, что у вас есть информация, необходимая для быстрого запуска Replay и максимально эффективного использования его мощных функций. Что нового Больше структуры Мы начали с определенной цели для каждого раздела нашей документации. Мы хотели упростить поиск ответов, необходимых для продвижения вперед с..
От базового до расширенного ведения журнала с помощью Python за 10 минут
Ускоренный курс ведения журналов с устранением распространенных проблем с ведением журналов В проекте Python легко отслеживать ход выполнения кода и отлаживать его, используя операторы печати и трассировку стека. Однако ведение журнала предоставляет дополнительные функции отслеживания и отладки с отметками времени, именем файла, номером строки кода и т. д., различая различные типы операторов печати и даже возможность сохранять операторы печати в файле журнала или в других местах, а не..
Документирование компонентов React
(В Атласките) Это краткое письменное изложение выступления мошенников, сделанного на campJS 2018. Контент в основном не изменился. Привет, приятно видеть вас здесь, в этой статье. Я хотел поговорить о работе, которую я и моя команда проделали за последний год или около того. Примерно последний год я работал над Атласкитом . В основном я уделял особое внимание тому, как мы документируем вещи и какие технологии мы используем для этого, но сначала: Отказ от ответственности: то, что..
Документирование вашей модели машинного обучения, реализованной с помощью FastAPI
Хорошая документация о том, как работает ваше приложение для машинного обучения, почти так же важна, как и само приложение, другие инженеры или ученые должны понимать, как оно работает, чтобы использовать его. Сегодня я не буду говорить о том, как написать отличную документацию для вашей высокопроизводительной модели. Вместо этого я дам вам несколько советов, как быстро создать потрясающую документацию для вашего проекта, смешав два моих любимых фреймворка/инструмента: FastAPI (..
Документы JS: краткое руководство
JSDocs — это способ документировать и добавлять информацию в написанный нами код. Эта информация отображается во всплывающей подсказке и облегчает разработчикам использование нашего кода. JSDocs также является генератором документации API, который сканирует файлы и создает документацию на основе документации JSDocs, добавленной к файлам. Вы также можете конвертировать JSDocs в TypeScript, что упрощает преобразование из ванильного JavaScript в TypeScript. Это краткое руководство..
Послание в бутылке
Бегая по пляжу, я наткнулся на бутылку внизу. Внутри был меморандум сценаристам из будущего с подробным описанием нынешних событий и ловушек. В некотором смысле, это то, о чем должны быть комментарии; сообщение для себя в будущем о том, почему здесь и сейчас. Скорее всего, это будете читать не вы, но тот ржавый кусок кода, смытый годами солнечного света и соли, который вы оставили миру, будет намного лучше с прикрепленным сообщением. Сообщение, которое я нашел, было эмоционально..
Понимание плагинов ESDoc
Моя команда использует ESDoc для создания документации по JS-проектам. Мы используем настраиваемые плагины, чтобы сгенерированные документы соответствовали нашим потребностям. Я написал пост об этих настраиваемых плагинах , но без предварительных знаний о том, как работают плагины ESDoc, он немного утомителен. Отсюда и этот пост. Очень краткий ESDoc 101 ESDOC - хороший генератор документации для JavaScript. ESDoc поддерживает из коробки код EcmaScript 2015 и использует теги..