Laravel по-русски

Русское сообщество разработки на PHP-фреймворке Laravel.

Ты не вошёл. Вход тут.

#1 18.11.2017 17:14:53

htclog81
Откуда: Москва
Сообщений: 192
Сайт

Комментарии методов

Везде в том числе в исходниках ларавель, вижу и пишу в своем коде комменты типа:

	/**
    * The attributes that aren't mass assignable.
    *
    * @var array
    */
    protected $guarded = [];
	
	
  
	/**
     * Indicates plan changes should be prorated.
     *
     * @var bool
     */
    protected $prorate = true;

    /**
     * Get the user that owns the subscription.
     */
    public function user()
    {
        return $this->owner();
    }

Но мне кажется писать их у каждого очевидного метода и поля класса лишнее, тормозит разработку и засоряет файлы. Итак ясно что такое dates что такое guarded, что за методы с отношениями, валидациями итд итп, тем более все это повторяется в множестве классов. А может и не писать? Как тут принято? Можно ли писать только у существенных и собственных методов..

Не в сети

#2 20.11.2017 15:24:09

Re: Комментарии методов

Мне не ясно, на вскидку, что такое dates и что такое guarded.
Только, к сожалению, далеко не всегда комментарии это доходчиво объясняют.

Поэтому моё скромное мнение — комментарии должны нормально и подробно описывать описываемое.
А если человеку это лениво, то лучше вообще не писать, чем делать отписки, просто потому что такой код-стайл.

Не в сети

#3 20.11.2017 16:12:21

htclog81
Откуда: Москва
Сообщений: 192
Сайт

Re: Комментарии методов

что такое dates и что такое guarded.

Это есть в документации в отличии например от содержимого собственных методов

Не в сети

#4 20.11.2017 16:32:34

Re: Комментарии методов

Если это методы, наследуемые, от родительского класса, то лучше камменты не повторять каждый раз.
Я пишу в этом случае:

/**
 * {@inheritdoc}
 */

Правда, к сожалению, я заметил, Laravel, почему-то не любит иметь базовые методы и вместо этого просто ищет метод через method_exists().
В этом случае какой-нибудь phpDocumentor может и сломаться о {@inheritdoc}

Не в сети

#5 20.11.2017 16:36:37

htclog81
Откуда: Москва
Сообщений: 192
Сайт

Re: Комментарии методов

В этом случае какой-нибудь phpDocumentor


Мы им не пользуемся..

Не в сети

#6 20.11.2017 16:36:51

htclog81
Откуда: Москва
Сообщений: 192
Сайт

Re: Комментарии методов

В общем как правильно сделать? И что бы меньше писать..

Не в сети

Подвал раздела