@kotmarvell

Что такое документация и с чем её едят (как правильно, как лучше?)?

Что такое документация и зачем она? Как правильно писать? Какие есть стили? (Очень прошу примеры, пожалуйста)
Посылать к гуглу не лучший вариант. Я делал это, но при поиске очень много воды.
Так что решил воспользоваться вопросом, раз уж есть такая возможность.
  • Вопрос задан
  • 135 просмотров
Решения вопроса 1
Konata69lol
@Konata69lol
backend php laravel
Берете phpstorm, пишите функцию/метод. Главное - указать, что принимает и возвращает функция.
По возможности используете тайп хинтинги (явное указание типов аргументов и возвращаемого значения).
alt+enter по названию функции -> generate doc block - phpstorm сгенерил вам док блоки.
Осталось добавить описание к функции сверху и к параметрам справа от них.
Ответ написан
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы