За последние 24 часа нас посетили 39860 программистов и 1275 роботов. Сейчас ищут 1276 программистов ...

Про документацию

Тема в разделе "PHP для новичков", создана пользователем Walk, 4 авг 2017.

  1. Walk

    Walk Активный пользователь

    С нами с:
    7 сен 2008
    Сообщения:
    452
    Симпатии:
    86
    Сложно найти какой-нибудь вопрос по php, и программированию в целом, где бы не нашлось умника, который скажет "читайте документацию, там все есть".

    Но лично мой опыт поиска информации показывает, что документации - самый бестолковый источник информации.

    И вот сегодняшний пример - Yii2, виджет ActiveForm, его метод begin()

    Что говорит документация:

    Ну вот спрашивается и что? Откуда мне знать что надо писать в параметрах?

    Документация не дает никакого ответа на этот вопрос.

    Смотрю примеры:
    PHP:
    1. ActiveForm::begin([
    2.     'action' => ['index'],
    3.     'method' => 'get',
    4. ])
    PHP:
    1. ActiveForm::begin([
    2.     'method' => 'GET',
    3.     'id' => 'search_responce_form',
    4.     'action' => '/cabinet/search-review',
    5.     'options' => ['class' => 'flexrow'],
    6. ])
    PHP:
    1. ActiveForm::begin([
    2.     'options' => ['onlick' => 'return false']
    3. ]
    Становится чуть более понятно, но все равно, приходится перебирать кучу примеров, экспериментировать самому, чтобы понять, какие могут быть параметры, их значения, и что они в итоге выводят в html.

    Так в чем польза от этих документаций? Если кто-то считает, что я не умею ими пользоваться - с удовольствием послушаю как же ими пользоваться.
     
    #1 Walk, 4 авг 2017
    Последнее редактирование: 4 авг 2017
  2. ADSoft

    ADSoft Старожил

    С нами с:
    12 мар 2007
    Сообщения:
    3.866
    Симпатии:
    753
    Адрес:
    Татарстан
    документация бывает разной, хорошей и плохой, полной и краткой, полезной и бесполезной....
    вопрос качества документации - он как и с качеством кода... где хорошая, где-то не очень
    но согласитесь, что лучше хоть какая-то информация, чем вообще никакой
    ну и интернет тем и хорош что существует множество источников информации,а не один
     
  3. denis01

    denis01 Суперстар
    Команда форума Модератор

    С нами с:
    9 дек 2014
    Сообщения:
    12.227
    Симпатии:
    1.714
    Адрес:
    Молдова, г.Кишинёв
    тогда смотри в Class Reference http://www.yiiframework.com/doc-2.0/index.html помогает сразу читать код framework и поиск хороший.
    --- Добавлено ---
    Просто читаем код https://github.com/yiisoft/yii2/blob/master/framework/base/Widget.php#L85
    --- Добавлено ---
    Она помогает быстро ориентироваться по возможностям framework, так как если ты не ищешь в интернете, то всегда можно почитать код самого yii2 и документация быстро поможет найти с какой точки начать капать.
    Можно погуглить если не хочешь разбираться сам. Вот так и живём.
    --- Добавлено ---
    http://www.yiiframework.com/doc-2.0/yii-widgets-activeform.html -> begin() -> http://www.yiiframework.com/doc-2.0/yii-base-widget.html#begin()-detail -> можно жать на глаз, чтобы посмотреть код, глаз чуть выше прокрути
     
  4. mkramer

    mkramer Суперстар
    Команда форума Модератор

    С нами с:
    20 июн 2012
    Сообщения:
    8.598
    Симпатии:
    1.764
    @Walk, если прочитать только эту строчку документации, то не понятно. Если до этого прочитать и вот это тоже: http://www.yiiframework.com/doc-2.0/guide-concept-components.html, http://www.yiiframework.com/doc-2.0/guide-concept-properties.html, то всё понятно. У yii2 специфическая инициализация полей через массивы. Когда я беру новый фреймворк, я пробегаю руководство от начала до конца. У меня нету суперпамяти, и всё не запоминается, но что-то начинаешь понимать. Пробежавшись по первой ссылке, становится понятно, что в массив можно пихать всё, что здесь описано как публичные свойства. И по названию Key Concepts сразу понятно, что это надо прочесть обязательно
     
    #4 mkramer, 4 авг 2017
    Последнее редактирование: 4 авг 2017
    denis01 нравится это.
  5. Fell-x27

    Fell-x27 Суперстар
    Команда форума Модератор

    С нами с:
    25 июл 2013
    Сообщения:
    12.156
    Симпатии:
    1.771
    Адрес:
    :сердА
    niet