Рекомендации по оформлению кода и вопросов

Тема в разделе "Инструкции и FAQ", создана пользователем Romans, 8 май 2015.

  1. Romans

    Romans Administrator Команда форума

    Сообщения:
    1.342
    Симпатии:
    702
    При написании вопроса или инструкций, просьба придерживаться рекомендаций.

    1. Оформляйте код в соответствующие теги, например, код для HTML, JS, SQL, можно заключить в теги code.

    Пример:

    для HTML, JS, SQL
    HTML:
    [code]<div class="bons">Привет</div>[/code]
    для PHP
    HTML:
    [php]<div class="bons">Привет</div>[/php]
    Данные коды вы можете вставить вручную или используя возможность редактора

    Для самостоятельного оформления кода, возможно использовать код qcode т.е вы можете сами выделить нужным цветом отдельные строки или сделать их жирными

    2015-05-08 12-04-40.png


    Для небольших участков кода, некоторые пользователи используют следующий формат записи:

    Пример

    ===========
    необходимо заменить в фале product\product.tpl
    это <div id="content" class="<?php echo $class; ?>"><?php echo $content_top; ?>
    на это <div id="content" class="<?php echo $class; ?>"></div>
    ===========


    2.
    Ссылки на файлы желательно выделять другим цветом, а сам файл жирным

    Пример:
    \catalog\view\theme\default\template\product\product.tpl

    Если инструкция сильно зависима от версии, т.е вы тестируете на версии намного ниже текущей, то формат записи может быть таков

    Пример:
    \catalog\view\theme\default\template\product\product.tpl v.2.0.1.1 строки ~ 200 - 205


    3. Изображения или файлы (особенно для инструкций) желательно прикреплять с помощью встроенных средств форума

    2015-05-08 12-07-28.png


    4. Если у вас большой список ошибок, изображений, текста или просто текст который необходимо спрятать в раскрывающий список, используйте кнопку Спойлер (см. изображение из п.1)
     
    Последнее редактирование: 23 июн 2015
    Bkmz, lavlan, Zlata Jesen и 3 другим нравится это.