Comment Lint
1 like366 views
Документ описывает необходимость использования инструмента comment lint для улучшения качества внутренней документации программных проектов, акцентируя внимание на важности понятных комментариев в коде. Утверждается, что комментарии помогают освободить время программистов для основных задач, таких как кодирование и отладка. Также приводится информация о функциональности инструмента, примерах применения и ценовых планах для различных компаний.
Comment Lint
- 1. COMMENT LINT ПОЧЕМУ ВАШЕМУ БИЗНЕСУ НУЖЕН
- 2. ИССЛЕДОВАНИЕ УЧЕТА ВРЕМЕНИ РАБОТЫ ПРОГРАММИСТОВ СКОЛЬКО ВРЕМЕНИ ПРОГРАММИСТ ТРАТИТ НА НАПИСАНИЕ ДОКУМЕНТАЦИИ ▸ Программисты редко читают внутреннюю документацию проекта, тяжело воспринимают старый код (читай: легаси), но уделяют пристальное внимание на комментарии в коде. ▸ Понятные комментарии в кодовой базе это простой способ повысить качество внутренней документации проекта. Удобная документация высвобождает труд программистов для кодирования и отладки. 10 % 25 % 45 % 20 % Кодирование Отладка Планирование Документация
- 3. АНАЛИЗ ПРЕДЛОЖЕННОГО РЕШЕНИЯ COMMENT LINT ПРОВЕРЯЕТ КАЧЕСТВО ЧИТАЕМОСТИ РУССКОЙ ДОКУМЕНТАЦИИ ▸ Написать хороший комментарий для программиста сложно: нужно отлично понимать предметную область, кодовую базу проекта и внятно излагать свои мысли. ▸ Наше решение автоматически проверяет комментарии, подсвечивает сложные для восприятия речевые формы. Подсказывает как улучшить читаемость текста, выделяет фразы паразиты, нецензурную лексику, неполиткорректные термины. ▸ Комментарии исправленные через Comment Lint сделают вашу документацию легкой для понимания и инклюзивно корректной.
- 4. ПРИМЕРЫ ПЛОХИХ КОММЕНТАРИЕВ И ИХ ПРОВЕРКА С ПОМОЩЬЮ ДВИЖКА COMMENT LINT КОММЕНТАРИИ ДОЛЖНЫ ОБЪЯСНЯТЬ НАМЕРЕНИЯ ПРОГРАММИСТА
- 5. ПРИМЕР РАБОТЫ COMMENT LINT ДЕМОНСТРАЦИЯ ВОЗМОЖНОСТЕЙ ПЛАГИНА
- 6. МЫ ОРИЕНТИРУЕМСЯ НА БОЛЬШИЕ КОМПАНИИ И КОМПАНИИ С ВЫСОКОЙ ТЕКУЧКОЙ КАДРОВ ЦЕНА РЕШЕНИЯ Демо режим Для небольших компаний Для больших компаний Для внедрения в инфраструктуру компании API: 1 запрос в минуту API: До 30к запросов в месяц API: До 200к запросов в месяц Самостоятельная установка (Docker) Бесплатно 130 тысяч рублей в год 250 тысяч рублей в год Цена по запросу
- 7. ДОРОЖНАЯ КАРТА COMMENT LINT РЕШЕНИЕ ПО СОКРАЩЕНИЮ ВРЕМЕНИ НА НАПИСАНИЕ ДОКУМЕНТАЦИИ ▸ Плагин уже работает на популярных продуктах от JetBrains: IntelliJ IDEA 2021+ WebStorm PhpStorm ▸ Планируется поддержка: Microsoft Visual Studio Code Sublime Text ▸ Поддержка MarkDown документации
- 8. АВТОРЫ ИДЕИ МЫ СПЛОЧЕННАЯ КОМАНДА ПРОФЕССИОНАЛОВ Денис Басковский Front End (MTC Ticketland) Егор Сафонов Java (СПбМТСБ) Анатолий Буров Python (GLVRD)
- 10. ИСПОЛЬЗУЕМЫЕ РЕСУРСЫ ПОЛЕЗНЫЕ ССЫЛКИ ▸ Персональный блог ИТ-консультанта Басковского Дениса https://baskovsky.ru/ ▸ Официальный сайт glvrd https://glvrd.ru/api/ ▸ Репозиторий проекта https://github.com/qertis/comment-lint