пятница, 22 апреля 2011 г.

Оформление сообщений

Поскольку форум нацелен на многократное прочтение тем, имеет смысл оформлять сообщение (как вопрос, так и ответ) аккуратно и выразительно. Это существенно повышает читаемость тем так, как хороший стиль кодирования повышает читаемость программного кода. Ниже представлен ряд правил по оформлению, которых мы рекомендуем придерживаться.

  • Заголовок сообщения начинается с большой буквы и оканчивается либо вопросительным знаком либо отсутствием знака препинания вообще.
  • Текст сообщений является литературным русским языком.
  • Абзацы в тексте разделяются пустой строкой (два перевода строки).
  • Прямые цитаты, сообщения об ошибках, отрывки логов оформляются как цитаты (символ >).
  • Код программ или скриптов пишется отдельным абзацем (четыре пробела).
  • Для форматирования кода используется общепринятый стиль кодирования, например, для программ на C под Linux: indent -linux code.c.
  • Ссылки оформляются как прямые ссылки с осмысленным названием (ХэшКод). 

Все эти простые правила во многом способствуют тому, что сообщение, оставленное участником форума, будет полезно многим другим читателям темы.

1 комментарий:

  1. И ссылки всегда должы быть подчеркнуты, ководства не читали?

    ОтветитьУдалить