Про стиль (coding convention) - История изменений

Linsky в 15:16, 9 сентября 2016

2016-09-09T15:16:46Z

Linsky в 15:16, 9 сентября 2016

2016-09-09T15:16:22Z

Linsky в 15:15, 9 сентября 2016

2016-09-09T15:15:46Z

Linsky в 15:14, 9 сентября 2016

2016-09-09T15:14:32Z

Linsky в 15:14, 9 сентября 2016

2016-09-09T15:14:17Z

Linsky в 15:09, 9 сентября 2016

2016-09-09T15:09:45Z

Linsky в 15:08, 9 сентября 2016

2016-09-09T15:08:47Z

Linsky: Новая страница: «Абсолютно правильного одного стиля нет. Люди обычно в начале проекта просто о чем-то дог…»

2016-09-09T15:05:03Z

Новая страница: «Абсолютно правильного одного стиля нет. Люди обычно в начале проекта просто о чем-то дог…»

Новая страница

Абсолютно правильного одного стиля нет. Люди обычно в начале проекта просто о чем-то договариваются.
Ниже приведен минимальный набор правил, которые встречаются в большинстве "договоров" (их выполнения мы будем контролировать).

a. В рамках одного проекта у всех файлов стиль один (у нас в рамках
одной лабы или дз)

b. Лучше не жалеть пробелов

int a = b + c;
f(4, 5, "fdfdffdf');

c. У вложенных конструкций должны быть отступы

for(...) {
if(...) {
}
}

d. Лучше не жалеть пустых строк

void f() {
for( ...) {
}

if(...) {
}
}

void g() {
int b = 5 + 6;
}

e. Перед отправкой на проверку желательно убрать все временно закомментированные участки кода

f. Имена

Осмысленные имена у переменных и функций.
Желательно, чтобы имена функций начинались с глагола.
Несколько слов в составе идентификатора лучше разделить (getNextPacket
или get_next_packet неважно, главное, чтобы везде одинаково).
Минимум сокращений (cur ---> current). Счетчиков в цикле это не касается.
Транслитерация с русского языка в именах переменных и функций не
приветствуется (massive, stroka --- отказать :)

g. В проекте должен быть Makefile, который по умолчанию делает сборку (но не запуск!). В Makefile должна быть цель clean, удаляющие все сгенерированные файлы.

f. А где еще почитать?

[http://mit.spbau.ru/sewiki/images/c/ce/Cpp_Standard_mistakes_shad.pdf Cтандартные ошибки] (ШАД)

[http://google-styleguide.googlecode.com/svn/trunk/cppguide.html Style guide] (Google)

@@ Строка 48: / Строка 48: @@
 * А где еще почитать?
+** [https://google.github.io/styleguide/cppguide.html Style guide] (Google)
-[https://google.github.io/styleguide/cppguide.html Style guide] (Google)
+** [http://mit.spbau.ru/sewiki/images/c/ce/Cpp_Standard_mistakes_shad.pdf Cтандартные ошибки] (ШАД)
-−
 [http://mit.spbau.ru/sewiki/images/c/ce/Cpp_Standard_mistakes_shad.pdf Cтандартные ошибки] (ШАД)

@@ Строка 39: / Строка 39: @@
 * Имена
 ** Должны быть осмысленные имена у переменных и функций.
 ** Желательно, чтобы имена функций начинались с глагола.

@@ Строка 40: / Строка 40: @@
 * Имена
-Должны быть осмысленные имена у переменных и функций. Желательно, чтобы имена функций начинались с глагола.
+** Должны быть осмысленные имена у переменных и функций.
-Несколько слов в составе идентификатора лучше разделить (getNextPacket или get_next_packet неважно, главное, чтобы везде одинаково).
+** Желательно, чтобы имена функций начинались с глагола.
-Минимум сокращений (cur ---> current). Счетчиков в цикле это не касается.
+** Несколько слов в составе идентификатора лучше разделить (getNextPacket или get_next_packet неважно, главное, чтобы везде одинаково).
-Транслитерация с русского языка в именах переменных и функций не приветствуется (massive, stroka --- отказать :)
+** Минимум сокращений (cur ---> current). Счетчиков в цикле это не касается.
 * В проекте должен быть Makefile, который по умолчанию делает сборку (но не запуск!). В Makefile должна быть цель clean, удаляющие все сгенерированные файлы.

@@ Строка 2: / Строка 2: @@
 Ниже приведен минимальный набор правил, которые встречаются  в большинстве "договоров" (их выполнения мы будем контролировать).
-* В рамках одного проекта у всех файлов стиль один (у нас в рамках
+* В рамках одного проекта у всех файлов стиль один (у нас в рамках одной лабы или дз)
 одной лабы или дз)
 * Лучше не жалеть пробелов

@@ Строка 2: / Строка 2: @@
 Ниже приведен минимальный набор правил, которые встречаются  в большинстве "договоров" (их выполнения мы будем контролировать).
-a. В рамках одного проекта у всех файлов стиль один (у нас в рамках
+* В рамках одного проекта у всех файлов стиль один (у нас в рамках
 одной лабы или дз)
-b. Лучше не жалеть пробелов
+* Лучше не жалеть пробелов
   <nowiki>
@@ Строка 12: / Строка 12: @@
 </nowiki>
-c. У вложенных конструкций должны быть отступы
+* У вложенных конструкций должны быть отступы
   <nowiki>
@@ Строка 21: / Строка 21: @@
 </nowiki>
-d. Лучше не жалеть пустых строк
+* Лучше не жалеть пустых строк
   <nowiki>
@@ Строка 37: / Строка 37: @@
 </nowiki>
-e. Перед отправкой на проверку желательно убрать все временно закомментированные  участки кода
+* Перед отправкой на проверку желательно убрать все временно закомментированные  участки кода
-f. Имена
+* Имена
-Осмысленные имена у переменных и функций.
+Должны быть осмысленные имена у переменных и функций. Желательно, чтобы имена функций начинались с глагола.
-Желательно, чтобы имена функций начинались с глагола.
+Несколько слов в составе идентификатора лучше разделить (getNextPacket или get_next_packet неважно, главное, чтобы везде одинаково).
 Несколько слов в составе идентификатора лучше разделить (getNextPacket
 или get_next_packet неважно, главное, чтобы везде одинаково).
 Минимум сокращений (cur ---> current). Счетчиков в цикле это не касается.
-Транслитерация с русского языка в именах переменных и функций не
+Транслитерация с русского языка в именах переменных и функций не приветствуется (massive, stroka --- отказать :)
 приветствуется (massive, stroka --- отказать :)
-g. В проекте должен быть Makefile, который по умолчанию делает сборку (но не запуск!). В Makefile должна быть цель clean, удаляющие все сгенерированные файлы.
+* В проекте должен быть Makefile, который по умолчанию делает сборку (но не запуск!). В Makefile должна быть цель clean, удаляющие все сгенерированные файлы.
-f. А где еще почитать?
+* А где еще почитать?
 [https://google.github.io/styleguide/cppguide.html Style guide] (Google)
 [http://mit.spbau.ru/sewiki/images/c/ce/Cpp_Standard_mistakes_shad.pdf Cтандартные ошибки] (ШАД)

@@ Строка 7: / Строка 7: @@
 b. Лучше не жалеть пробелов
 int a = b + c;
 f(4, 5, "fdfdffdf');
 c. У вложенных конструкций должны быть отступы
 for(...) {
      if(...) {
+     }
+}
 d. Лучше не жалеть пустых строк
 void f() {
      for( ...) {
@@ Строка 30: / Строка 35: @@
      int b = 5 + 6;
+}
+</nowiki>
 e. Перед отправкой на проверку желательно убрать все временно закомментированные  участки кода
@@ Строка 48: / Строка 53: @@
 f. А где еще почитать?
-[http://mit.spbau.ru/sewiki/images/c/ce/Cpp_Standard_mistakes_shad.pdf Cтандартные ошибки] (ШАД)
+[https://google.github.io/styleguide/cppguide.html Style guide] (Google)
-[http://google-styleguide.googlecode.com/svn/trunk/cppguide.html Style guide] (Google)
+[http://mit.spbau.ru/sewiki/images/c/ce/Cpp_Standard_mistakes_shad.pdf Cтандартные ошибки] (ШАД)