C++ coding Conventions - История изменений

Korogodin в 10:47, 11 ноября 2013

2013-11-11T10:47:32Z

Korogodin: /* Объявление переменных */

2013-11-11T10:36:08Z

‎Объявление переменных

Korogodin: /* Использование конструкции switch */

2013-11-11T10:35:34Z

‎Использование конструкции switch

Korogodin: /* Круглые скобки */

2013-11-11T10:35:26Z

‎Круглые скобки

Korogodin в 10:35, 11 ноября 2013

2013-11-11T10:35:13Z

Korogodin: /* Правила написания кода с использованием Qt */

2013-07-11T09:53:48Z

‎Правила написания кода с использованием Qt

Korogodin: /* Ссылки */

2013-07-11T09:52:57Z

‎Ссылки

Ippolitov: /* Правила кодирования с использованием Qt */

2013-07-11T09:50:41Z

‎Правила кодирования с использованием Qt

Ippolitov в 09:42, 11 июля 2013

2013-07-11T09:42:35Z

Ippolitov: /* Объявление переменных */

2013-07-11T09:38:36Z

‎Объявление переменных

← Предыдущая		Версия 10:47, 11 ноября 2013
Строка 207:		Строка 207:

	*Не бойтесь нарушать описанные выше правила, если вам кажется, что они только запутают ваш код.		*Не бойтесь нарушать описанные выше правила, если вам кажется, что они только запутают ваш код.
		+
		+	[[Категория:Импала]]
		+	[[Категория:Разработка]]

@@ Строка 14: / Строка 14: @@
 *Односимвольные имена переменных подходят только для итераторов циклов, небольшого локального контекста и временных переменных. В остальных случаях имя переменной должно отражать ее назначение.
 *Заводите переменные только по мере необходимости.
 <source lang="cpp"> // Так не правильно

@@ Строка 169: / Строка 169: @@
          (a + b) & c</source>
-=Использование конструкции switch=
+==Использование конструкции switch==
 *Операторы case должны быть в одном столбце со switch

@@ Строка 154: / Строка 154: @@
          while (a) {}
 </source>
-=Круглые скобки=
+==Круглые скобки==
 *Используйте круглые скобки для группировки выражений:

@@ Строка 1: / Строка 1: @@
-=Общее=
+==Общее==
 Данный свод правил основан на [http://qt-project.org/wiki/Qt_Coding_Style Qt Coding Convention]. Она собрана из разных источников: документации по Qt, тематических форумов, e-mail списков рассылки и опыта различных разработчиков.
-=Отступы=
+== Отступы ==
 *Для обозначения отступа используйте 4 пробела подряд
 *Используйте пробелы, а не табуляцию!
-=Объявление переменных=
+==Объявление переменных==
 *Объявляйте по одной переменной в строке.
@@ Строка 39: / Строка 39: @@
 *Имена классов всегда начинаются с заглавной буквы. Public-классы начинаются с буквы ‘Q’ (QRgb). Public-функции должны начинаться с прописной буквы ‘q’ (qRgb).
-=Пробелы=
+==Пробелы==
 *Используйте пустые строки для логической группировки операторов, где это возможно.
@@ Строка 69: / Строка 69: @@
   char *blockOfMemory = reinterpret_cast<char *>(malloc(data.size()));</source>
-=Фигурные скобки=
+==Фигурные скобки==
 *Возьмите за основу расстановку открывающих фигурных скобок на одной строке с выражением, которому они предшествуют
@@ Строка 185: / Строка 185: @@
+         }
 </source>
-=Разрыв строк=
+==Разрыв строк==
 *Длина строки кода не должна превышать 100 символов. Если надо – используйте разрыв строки.
@@ Строка 201: / Строка 201: @@
+         }
 </source>
-=Наследование и ключевое слово `virtual`=
+==Наследование и ключевое слово `virtual`==
 *При переопределении virtual-метода, ни за что не помещайте слово `virtual` в заголовочный файл.
-=Главное исключение=
+==Главное исключение==
 *Не бойтесь нарушать описанные выше правила, если вам кажется, что они только запутают ваш код.

← Предыдущая		Версия 09:52, 11 июля 2013
Строка 208:		Строка 208:

	*Не бойтесь нарушать описанные выше правила, если вам кажется, что они только запутают ваш код.		*Не бойтесь нарушать описанные выше правила, если вам кажется, что они только запутают ваш код.
−
−	~~=Ссылки=~~
−	~~http://qt-project.org/wiki/Qt_Coding_Style~~

← Предыдущая		Версия 09:50, 11 июля 2013
Строка 1:		Строка 1:
−	=Правила ~~кодирования~~ с использованием Qt=	+	=Правила написания кода с использованием Qt=

	Ниже представлен обзор соглашений по написанию кода с использованием Qt. Эта информация была собрана здесь из разных источников: документации по Qt, тематических форумов, e-mail списков рассылки и опыта различных разработчиков.		Ниже представлен обзор соглашений по написанию кода с использованием Qt. Эта информация была собрана здесь из разных источников: документации по Qt, тематических форумов, e-mail списков рассылки и опыта различных разработчиков.

@@ Строка 45: / Строка 45: @@
 *Всегда используйте один пробел перед фигурной скобкой
- // Неправильно
+<source lang="cpp"> // Неправильно
   if(foo){
+  }
@@ Строка 51: / Строка 51: @@
   // Правильно
   if (foo) {
+  }</source>
 *Всегда ставьте один пробел после ‘*’ или ‘&’, если они стоят перед описанием типов. Но никогда не ставьте пробелы после ‘*’ или ‘&’ и именем переменной.
- char *x;
+<source lang="cpp"> char *x;
   const QString &myString;
-  const char * const y = "hello";
+  const char * const y = "hello";</source>
 *Бинарные операции отделяются пробелами с 2-х сторон.
@@ Строка 63: / Строка 63: @@
 *Избегайте преобразования типов в стиле C.
-  // Неправильно
+  <source lang="cpp">// Неправильно
   char* blockOfMemory = (char* ) malloc(data.size());
   // Правильно
-  char *blockOfMemory = reinterpret_cast<char *>(malloc(data.size()));
+  char *blockOfMemory = reinterpret_cast<char *>(malloc(data.size()));</source>
 =Фигурные скобки=
@@ Строка 73: / Строка 73: @@
 *Возьмите за основу расстановку открывающих фигурных скобок на одной строке с выражением, которому они предшествуют
-  // Неправильно
+  <source lang="cpp">// Неправильно
   if (codec)
+  {
@@ Строка 81: / Строка 81: @@
   if (codec) {
+  }
+</source>
 *Исключение: Тело функции и описание класса всегда открывается фигурной скобкой, стоящей на новой строке
- static void foo(int g)
+<source lang="cpp"> static void foo(int g)
+  {
   qDebug("foo: %i", g);
@@ Строка 92: / Строка 92: @@
+  {
   };
+</source>
 *Используйте фигурные скобки в условиях, если тело условия в размере превышает одну линию, или тело условия достаточное сложное и выделение скобками действительно необходимо
-        // Неправильно
+       <source lang="cpp"> // Неправильно
          if (address.isEmpty()) {
              return false;
@@ Строка 108: / Строка 108: @@
          for (int i = 0; i < 10; ++i)
-             qDebug("%i", i);
+             qDebug("%i", i);</source>
 *Исключение 1: Используйте скобки, если родительское выражение состоит из нескольких строк / оберток
-        // Правильно
+      <source lang="cpp">  // Правильно
          if (address.isEmpty() || !isValid()
              || !codec) {
              return false;
+         }</source>
 Исключение 2: Используйте фигурные скобки, когда тела ветвлений if-then-else занимают несколько строчек
-        // Неправильно
+<source lang="cpp">        // Неправильно
          if (address.isEmpty())
              return false;
@@ Строка 146: / Строка 146: @@
              else
                  ...
+         }</source>
 *Используйте фигурные скобки для обозначения пустого тела условия
-        // Неправильно
+   <source lang="cpp">// Неправильно
          while (a);
          // Правильно
          while (a) {}
+</source>
 =Круглые скобки=
 *Используйте круглые скобки для группировки выражений:
-        // Неправильно
+       <source lang="cpp"> // Неправильно
          if (a && b || c)
@@ Строка 167: / Строка 167: @@
          // Правильно
-         (a + b) & c
+         (a + b) & c</source>
 =Использование конструкции switch=
@@ Строка 173: / Строка 173: @@
 *Операторы case должны быть в одном столбце со switch
 *Каждый оператор case должен иметь закрывающий break (или return) или комментарий, котрой предполагает намеренное отсутсвие break & return.
-        switch (myEnum) {
+      <source lang="cpp">  switch (myEnum) {
          case Value1:
              doSomething();
@@ Строка 184: / Строка 184: @@
              break;
+         }
+</source>
 =Разрыв строк=
 *Длина строки кода не должна превышать 100 символов. Если надо – используйте разрыв строки.
 *Запятые помещаются в конец разорванной линии; операторы помещаются в начало новой строки. В зависимости от используемой вами IDE, оператор на конце разорванной строки можно проглядеть.
-        // Правильно
+       <source lang="cpp"> // Правильно
          if (longExpression
              + otherLongExpression
@@ Строка 200: / Строка 200: @@
              otherOtherLongExpression) {
+         }
+</source>
 =Наследование и ключевое слово `virtual`=

@@ Строка 16: / Строка 16: @@
- // Так не правильно
+<source lang="cpp"> // Так не правильно
   int a, b;
   char *c, *d;
@@ Строка 24: / Строка 24: @@
   int width;
   char *nameOfThis;
-  char *nameOfThat;
+  char *nameOfThat;</source>
 *Функции и переменные должны именоваться с прописной буквы, а если имя переменной или функции состоит из нескольких слов, то первое слово должно начинаться с прописной буквы, остальные – со строчных.
 *Избегайте аббревиатур
- // Не правильно
+<source lang="cpp"> // Не правильно
   short Cntr;
   char ITEM_DELIM = '\t';
@@ Строка 35: / Строка 35: @@
   // Правильно
   short counter;
-  char itemDelimiter = '\t';
+  char itemDelimiter = '\t';</source>
 *Имена классов всегда начинаются с заглавной буквы. Public-классы начинаются с буквы ‘Q’ (QRgb). Public-функции должны начинаться с прописной буквы ‘q’ (qRgb).