Документация по переменным класса Laravel eloquent
Я создаю веб-сайт с помощью laravel, и у меня возникли проблемы с документированием переменных в красноречивом классе. Я видел, что класс eloquent использует массив атрибутов для хранения всех переменных. Я хотел бы документировать доступные атрибуты в моих классах, чтобы я мог легко генерировать документацию и иметь завершение кода с описаниями.
Я попытался объявить переменные в классах для документации. Я пытался объявить их общедоступными, но тогда массив атрибутов больше не используется, что необходимо. Объявление их защищенными работает для массива атрибутов, но объявленные переменные не используются, а документация и объявления не доступны в других файлах для завершения кода, предложений и описаний.
Я также хотел бы избежать геттеров и сеттеров.
Есть ли удобный способ документирования этих переменных в laravel?
Заранее спасибо!
Решение
Вы можете задокументировать переменные-члены с @property:
/**
* @property string foo
* @property int bar
*/
class MyModel extends Eloquent {
}
Другие решения
Других решений пока нет …