Мой проект использует FoundationPress, начальную тему WordPress. Я использую Github и обновляю свой проект из родительского репозитория upstream remote
когда сообщество улучшает код. Кстати, я программировал долгое время, но почти всегда один, и я очень неопытен с докблоками и документацией в коде. Я знаю, что в какой-то степени это может быть основано на мнении, поскольку это, кажется, тенденция поиска других ответов, но я чувствую, что не понимаю правильного использования.
Родительский проект использует PHP Docblocks, которые выглядят так на PHP-файлах, всегда только один раз на файл, например:
/**
* Brief File Description
*
* @package FoundationPress
* @since FoundationPress 1.0.0
*/
Когда я добавляю новые собственные файлы PHP, я добавляю похожий блок, но вместо этого использую имя для своего проекта:
/**
* Brief File Description
*
* @package MyProject
* @since MyProject 0.1.0
*/
Иногда я обновляю существующий файл своими собственными функциями. Я ставлю @since
выше этих функций, вот так:
/**
* Brief File Description
*
* @package FoundationPress
* @since FoundationPress 1.0.0
*/
function foo() { ... }
function bar() { ... }
/**
* My Function Description
*
* @since MyProject 0.1.0
*/
function my_foo() { ... }
В других случаях я обновляю существующую функцию — я просто оставляю докблок для них, но мне интересно, стоит ли мне что-то обновлять.
Моя цель — создать код & документация в коде в формате, который коллеги или будущие сопровождающие могут найти полезным в будущем.
Задача ещё не решена.
Других решений пока нет …