Форум программистов, компьютерный форум, киберфорум
Наши страницы
C++ Qt
Войти
Регистрация
Восстановить пароль
 
Рейтинг 4.53/30: Рейтинг темы: голосов - 30, средняя оценка - 4.53
Wyn
1056 / 638 / 229
Регистрация: 14.01.2016
Сообщений: 2,031
Записей в блоге: 9
#1

Правила именования тем и оформления сообщений в разделе Qt

30.01.2017, 16:14. Просмотров 5373. Ответов 0

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

Коротко по именованию тем:

Обязательно: название темы должно начинаться с большой буквы.
Предпочтительно: использовать оригинальные названия классов и механизмов.
Хорошо: "Проблемы с форматированием текста в QLineEdit"
Терпимо: "Проблемы с форматированием текста в qlineedit"
Плохо: "проблемы с форматированием текста в лайнедит"

По оформлению сообщений:
  • Код С++, который использует механизмы и выражения из Qt, необходимо выделять тегом CPPQT(кнопка "С++QT" на панели редактирования сообщения).
    Код С++, который для компиляции не требует Qt, можно обозначать как тегом CPP(кнопка "С++" на панели редактирования сообщения), так и тегом CPPQT. Если нет понимания, что и где лучше использовать, то лучше используйте тег CPPQT.

  • Код QML выделяется тегом JS.

  • Код QSS выделяется тегом CSS.

  • Вывод консоли выделяется тегом BASH или CODE. CODE обязателен в случае большого(более 20ти строк) вывода консоли.

  • Код файла проекта Qt(.pro файл) выделяется тегом CODE(кнопка "#" на панели редактирования сообщения).

  • Тег INLINE применяется для включения строки с кодом в текст. Это очень важный тег, о котором многие забывают и в итоге в своих сообщениях получают QDir:ath вместо QDir::path. Также для подобных ситуаций можно использовать тег NOPARSE или в опциях сообщения поставить галку напротив "Отключить смайлы в тексте".

  • По поводу цитирования документации, сообщений или других вещей из интернета есть лишь пара наставлений:
    • Нужно, чтобы было понятно, что приведённый текст - это цитата откуда-то. Поэтому допускается его выделение с помощью тега QUOTE(цитирование), тега B(жирный текст), тега I(курсив) или любого другого тега, обеспечивающего нужное обособление от остального текста.
    • Желательно не только приводить ссылку на место, откуда цитата взята, но также письменно описывать это место, чтобы и без перехода по ссылке было понятно откуда произошло цитирование. Пример: "Выдержка из документации".

  • К сожалению на форуме иногда попадается баг с тем, что форум автоматически загоняет ссылки в тег URL. В итоге может получиться нечто подобное:
    Bash
    1
    
    git https:\\[url]www.blabla.git[/url]
    В случае возникновения подобной проблемы - зайдите в расширенный режим редактирования сообщения и снимите галку с опции "Автоматически вставлять ссылки".

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

Данная тема будет дополняться и изменяться по ходу работы.
Обсуждение по улучшению данной темы ведётся здесь..
0
Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
Similar
Эксперт
41792 / 34177 / 6122
Регистрация: 12.04.2006
Сообщений: 57,940
30.01.2017, 16:14
Ответы с готовыми решениями:

Обсуждение Правил именования тем и оформления сообщений в разделе Qt
Данная тема создана для обсуждения и улучшения Правил именования тем и...

Правила создания тем в данном разделе. Читать обязательно!
Данная тема в основном ориентированна на аппаратные проблемы, такие как...

Правила именования переменных
Доброго времени суток! У нас в коллективе нередко возникают споры вот по...

Правила именования переменных
Один из самых сложных вопросов для меня, как назвать переменную? Некоторое...

Правила именования классов в CSS
Добрый ночи, у меня такой вопрос небольшой. Просто недавно смотрел пару...

0
MoreAnswers
Эксперт
37091 / 29110 / 5898
Регистрация: 17.06.2006
Сообщений: 43,301
30.01.2017, 16:14

Правила оформления кода
Почему рекомендует писать классы и функции следующим образом?(вроде как...

Правила оформления программы
Ребята, поделитесь своими фишками\секретами\правилами и т.п. и т.д. при...

Правила оформления кода
Здравствуйте. Что то порылся в поиске и не нашел. Подскажите статьи,...


Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
1
Ответ Создать тему
Опции темы

КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin® Version 3.8.9
Copyright ©2000 - 2018, vBulletin Solutions, Inc.
Рейтинг@Mail.ru