Дарт Документация
Введение
Сегодня вы узнаете, как сделать документацию профессионально, полностью, следуя правилам документации, принятым Dart, и создать веб-сайт вашей документации.
Зачем это документировать?
Подумайте о коде, который вы написали на этой неделе, оценивая его напористость? А через три месяца напористость останется прежней?
Многие разработчики пишут код так, как будто он циклически повторяет «один раз написал никогда не забудешь», но все не совсем так, мы пишем тысячи строк каждый месяц и иногда работаем над разными проектами, что вызывает большой поток информация из той же темы, так что когда мы смотрим на код 3-х месячной давности и видим переменную с именем «isAccepted» неужели не будем понимать контекст только по имени, ведь в каком он, она или это принимается?
И вот тогда вы думаете, о, если бы у вас была документация моего кода, равная языку, который я использую, и вы могли бы ее получить, но вы думаете, что очень сложно делать все эти сайты и ссылки на классы, переменные и функции, но что? если я скажу, что после прочтения этой статьи вы сможете построить документацию своего кода просто, красиво и полно, то это мы и увидим дальше
Как документировать
Документация была в обобщенном виде, где вы ставите «///», потому что их расположение будет отвечать за то, о чем мы говорим, возьмите пример:
Символы «///» над классом или функцией означают, что вы документируете это, то есть то, что не работает.
Таким образом, эта документация будет выглядеть так:
Это работает для других функций:
Форматирование:
Документирование Dart допускает форматирование типа Markdown, если вы не знаете, как получить доступ к ссылке: https://www.markdownguide.org/getting-started/
Преобразование кода в HTML
Теперь мы подошли к лучшей части, где мы превратим все, что вы написали, в профессиональную документацию, равную официальной документации по дротикам.
Написав значения классов, функций и некоторых переменных, запустите код:
Дартдок .
Если эта команда не работает, выполните команду:
Глобальный запуск Flutter pub dartdoc .
В некоторых версиях flutter не принимает командуdartdoc. в этих случаях мы предлагаем второй вариант.
ПРИМЕЧАНИЕ:“ . В конце команды имеется в виду задокументировать все файлы, если вы хотели указать тип:
Глобальный запуск Flutter pub dartdoc app/yourFile.dart
После запуска команда flutter/dart сгенерирует всю вашу документацию, готовую для размещения на каком-либо сервере (если вы хотите) или на странице Github, что было бы отличной идеей.
Выполняемый код
После запуска кода флаттер создаст папку с именем «doc», расположенную в корне проекта, получите доступ к ней, и у вас будут указаны все ее классы и файл, содержащий всю документацию:
После нахождения файла, содержащего всю документацию, выполните:
Примечание. Он установил расширение Live Preview, которое позволяет мне просматривать HTML-файлы в VsCode.
И готово, теперь ваш код полностью и профессионально задокументирован, вам понравился инструмент, и вы узнаете больше о том, как документировать, следуя правилам дротика, поэтому перейдите по ссылке:
Правила документации: https://dart.dev/guides/language/efficient-dart/documentation
Как создать документацию: https://dart.dev/tools/dart-doc
