Рейтинг:-2

Как автоматически генерировать документацию для моего сайта?

флаг hk

Я работаю над сложным сайтом Drupal с множеством настраиваемых модулей, настраиваемых сущностей, настраиваемых классов, настраиваемых представлений, настраиваемых событий, настраиваемых подписчиков событий, настраиваемых форм, настраиваемых контроллеров. Короче говоря, много пользовательского кода.

Очень сложно поддерживать техническую документацию системы в актуальном состоянии, когда мы постоянно вносим изменения в приложение.

Есть ли способ автоматически генерировать техническую документацию для сайта? Например.

Модуль используется для x, y, z Для таких вещей используется вид V, блоки просмотра используются на таких-то страницах. Тип контента C используется для l, m, n и используется в представлениях V1, V2, V3.

Если не полностью автоматически, то хотя бы частично, и есть ли какой-то механизм для добавления оставшихся элементов вручную?

Редактировать: Спасибо за подсказку по поводу модуля API @cilefen. Кажется, это хороший способ создать документацию о пользовательском коде. Однако есть части, которые также являются частью конфигурации, такие как представления, макеты, блоки и т. д. Они не будут задокументированы в модуле API.

Рейтинг:1
флаг id

Использовать модуль API генерировать документацию из кода. Doxygen или phpDocumentor также могут подойти вам, в зависимости от ваших потребностей.

Jaypan avatar
флаг de
Я второй модуль API.
флаг hk
Спасибо за подсказку по поводу модуля API. Это интересный вариант. Как вы документируете представления, макеты, типы контента и другие элементы, являющиеся частью конфигурации?
флаг id
Это также модуль API. Считайте, что любой файл *.api.php в Drupal генерирует страницы на сайте API. Теперь мы входим на территорию мнений, но также https://www.mkdocs.org прост и удобен для специальной документации.

Ответить или комментировать

Большинство людей не понимают, что склонность к познанию нового открывает путь к обучению и улучшает межличностные связи. В исследованиях Элисон, например, хотя люди могли точно вспомнить, сколько вопросов было задано в их разговорах, они не чувствовали интуитивно связи между вопросами и симпатиями. В четырех исследованиях, в которых участники сами участвовали в разговорах или читали стенограммы чужих разговоров, люди, как правило, не осознавали, что задаваемый вопрос повлияет — или повлиял — на уровень дружбы между собеседниками.