C++ Core Guidelines - История изменений

Admin: /* I.3: Избегать синглтонов */

2024-05-22T19:27:34Z

I.3: Избегать синглтонов

Admin в 16:20, 9 апреля 2021

2021-04-09T16:20:34Z

Admin в 18:39, 8 июля 2020

2020-07-08T18:39:24Z

Admin: /* O: Оффтоп */

2020-06-24T13:45:00Z

O: Оффтоп

Admin в 18:55, 23 июня 2020

2020-06-23T18:55:21Z

Admin: /* I.1: Делать интерфейсы явными */

2019-10-06T21:31:25Z

I.1: Делать интерфейсы явными

Admin: /* F.call: Передача аргументов */

2019-10-06T21:22:28Z

F.call: Передача аргументов

Admin: /* F: Функции */

2019-10-06T21:13:56Z

F: Функции

Admin: /* F: Функции */

2019-04-06T22:38:19Z

F: Функции

Admin: /* I.30: Инкапсулировать опасный код */

2019-04-06T22:37:54Z

I.30: Инкапсулировать опасный код

@@ Строка 187: / Строка 187: @@
 === I.3: Избегать синглтонов ===
-Хз, что авторы тут вообще хотели сказать. В качестве альтернативного решения приведён синглтон Майерса :) Названием правила должно быть "предпочитать синглтон Майерса классическим с кучей кода инициализации". Не вижу глобальной разницы между синглтоном и единственным экземпляром класса, однако объявление рабочих методов такого класса статическими и обращение к ним через :: положительно сказывается на читабельности программы (см. P.1)
+Хз, что авторы тут вообще хотели сказать. В качестве альтернативного решения приведён синглтон Майерса :) Названием правила должно быть "предпочитать синглтон Майерса классическим с кучей кода инициализации". Не вижу глобальной разницы между синглтоном и единственным экземпляром класса, однако объявление рабочих методов такого класса статическими и обращение к ним через :: положительно сказывается на читабельности программы (см. P.1).
 === I.4: Интерфейсы должны быть тщательно и жёстко типизированы ===

@@ Строка 344: / Строка 344: @@
 === F.15: Чем проще - тем лучше ===
-Использование хитромудрых способов передачи аргументов, т. к. они могут привести к сюрпризам и из сложнее понять коллегам. Убедиться, что нестандартный способ - это действительно необходимо и действительно оптимизация, а не наоборот. Тщательно документировать.
+Использование хитромудрых способов передачи аргументов может привести к сюрпризам и их сложнее понять коллегам. Убедиться, что нестандартный способ - это действительно необходимо и действительно оптимизация, а не наоборот. Тщательно документировать.
 === F.16: Для входных аргументов дешёвые в копировании типы передавать по значению, остальные по const& ===
 Оба способа позволяют обозначить, что функция не меняет аргумент, и оба позволяют инициализацию rvalue'м. "Дешёвые в копировании" - числа, ссылки и т. п.

← Предыдущая		Версия 18:39, 8 июля 2020
Строка 9:		Строка 9:
	Все аргументы разделяются пробелами. Аргументы делятся на опции, параметры и операнды. Опции начинаются с "-" или "--". Опция из одного символа называется "флаг", флаги начинаются с "-", длинные (более одного символа) опции с "--". Флаги без параметров могут указываться все вместе слитно с одним "-" (в примере выше: utility_name -abd). У опции может быть только один параметр. Параметр с флагом может писаться без пробела (-fmy_file_name). Считается хорошим тоном для всех параметров, передаваемых приложению, предусматривать как флаги, так и их длинные варианты (-h и --help). Для длинной опции параметр пишется через "=" (--file=my_file_name). Операнды могут быть только в самом конце, после всех опций и параметров, перечисляются через пробел. Операнд не может начинаться с "-" (будет распарсен как опция).		Все аргументы разделяются пробелами. Аргументы делятся на опции, параметры и операнды. Опции начинаются с "-" или "--". Опция из одного символа называется "флаг", флаги начинаются с "-", длинные (более одного символа) опции с "--". Флаги без параметров могут указываться все вместе слитно с одним "-" (в примере выше: utility_name -abd). У опции может быть только один параметр. Параметр с флагом может писаться без пробела (-fmy_file_name). Считается хорошим тоном для всех параметров, передаваемых приложению, предусматривать как флаги, так и их длинные варианты (-h и --help). Для длинной опции параметр пишется через "=" (--file=my_file_name). Операнды могут быть только в самом конце, после всех опций и параметров, перечисляются через пробел. Операнд не может начинаться с "-" (будет распарсен как опция).

		+	= C++ Core Guidelines =

	Вольный перевод (скорее, изложение) https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md		Вольный перевод (скорее, изложение) https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md

← Предыдущая		Версия 13:45, 24 июня 2020
Строка 7:		Строка 7:
	<pre>utility_name [-a] [-b] [-c параметр [параметр]] [-d\|-e] [-f[параметр]] [operand...]</pre>		<pre>utility_name [-a] [-b] [-c параметр [параметр]] [-d\|-e] [-f[параметр]] [operand...]</pre>

−	Все аргументы разделяются пробелами. Аргументы делятся на опции, параметры и операнды. Опции начинаются с "-" или "--". Опция из одного символа называется "флаг", флаги могут указываться слитно с одним "-" (в примере выше: utility_name -abd). У опции может быть более одного параметра, в этом случае они указываются через пробел, параметрами считается всё, что не начинается с "-" (это будет следующая опция). Флаг может иметь один ~~обязательный~~ параметр~~, в этом случае пробела между~~ флагом ~~и параметром~~ может ~~не быть~~ (-fmy_file_name)~~. Флаги начинаются с "-", длинные (более одного символа) опции с "--"~~. Считается хорошим тоном для всех параметров, передаваемых приложению, предусматривать как флаги, так и их длинные варианты (-h и --help). Для длинной опции ~~один обязательный~~ параметр ~~может быть передан~~ через "=" (--file=my_file_name)~~, несколько параметров - через пробелы~~. Операнды могут быть только в самом конце, после всех опций и параметров.	+	Все аргументы разделяются пробелами. Аргументы делятся на опции, параметры и операнды. Опции начинаются с "-" или "--". Опция из одного символа называется "флаг", флаги начинаются с "-", длинные (более одного символа) опции с "--". Флаги без параметров могут указываться все вместе слитно с одним "-" (в примере выше: utility_name -abd). У опции может быть только один параметр. Параметр с флагом может писаться без пробела (-fmy_file_name). Считается хорошим тоном для всех параметров, передаваемых приложению, предусматривать как флаги, так и их длинные варианты (-h и --help). Для длинной опции параметр пишется через "=" (--file=my_file_name). Операнды могут быть только в самом конце, после всех опций и параметров, перечисляются через пробел. Операнд не может начинаться с "-" (будет распарсен как опция).

← Предыдущая		Версия 18:55, 23 июня 2020
Строка 1:		Строка 1:
		+	== O: Оффтоп ==
		+
		+	Соглашения об аргументах командной строки (POSIX.1-2017 Utility Argument Syntax, https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html)
		+
		+	Командная строка выглядит так:
		+
		+	<pre>utility_name [-a] [-b] [-c параметр [параметр]] [-d\|-e] [-f[параметр]] [operand...]</pre>
		+
		+	Все аргументы разделяются пробелами. Аргументы делятся на опции, параметры и операнды. Опции начинаются с "-" или "--". Опция из одного символа называется "флаг", флаги могут указываться слитно с одним "-" (в примере выше: utility_name -abd). У опции может быть более одного параметра, в этом случае они указываются через пробел, параметрами считается всё, что не начинается с "-" (это будет следующая опция). Флаг может иметь один обязательный параметр, в этом случае пробела между флагом и параметром может не быть (-fmy_file_name). Флаги начинаются с "-", длинные (более одного символа) опции с "--". Считается хорошим тоном для всех параметров, передаваемых приложению, предусматривать как флаги, так и их длинные варианты (-h и --help). Для длинной опции один обязательный параметр может быть передан через "=" (--file=my_file_name), несколько параметров - через пробелы. Операнды могут быть только в самом конце, после всех опций и параметров.
		+
		+
	Вольный перевод (скорее, изложение) https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md		Вольный перевод (скорее, изложение) https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md

@@ Строка 159: / Строка 159: @@
 === I.1: Делать интерфейсы явными ===
-Предположения, явно не отражённые в интерфейсе, легко забыть и сложно протестировать. Например, если поведение функции зависит от некоей глобальной переменной - два вызова в разное время вернут разные значения, что на первый взгляд покажется необъяснимым. Исключение - глобальные "переменные среды", управляющие деталями реализации некоей фиксированной семантики, например - уровни логгинга.
+Предположения, явно не отражённые в интерфейсе, легко забыть и сложно протестировать. Например, если поведение функции зависит от некоей глобальной переменной - два вызова в разное время вернут разные значения, что на первый взгляд покажется необъяснимым. Исключение - глобальные "переменные среды", управляющие деталями реализации некоей фиксированной логики, например - уровни логгинга.
 Пример неявного интерфейса - возвращать значение удача/ошибка, которое легко может быть проигнорировано. Оптимально в этом случае бросать исключение, которое игнорировать невозможно.

← Предыдущая		Версия 21:22, 6 октября 2019
Строка 329:		Строка 329:

	== F.call: Передача аргументов ==		== F.call: Передача аргументов ==
		+
		+	=== F.15: Чем проще - тем лучше ===
		+
		+	Использование хитромудрых способов передачи аргументов, т. к. они могут привести к сюрпризам и из сложнее понять коллегам. Убедиться, что нестандартный способ - это действительно необходимо и действительно оптимизация, а не наоборот. Тщательно документировать.
		+
		+	=== F.16: Для входных аргументов дешёвые в копировании типы передавать по значению, остальные по const& ===
		+
		+	Оба способа позволяют обозначить, что функция не меняет аргумент, и оба позволяют инициализацию rvalue'м. "Дешёвые в копировании" - числа, ссылки и т. п.

← Предыдущая		Версия 21:13, 6 октября 2019
Строка 305:		Строка 305:

	Если после этого глубокой ночью в тёмном-тёмном лесу запустить компиляцию и прислушаться, можно услышать как в глубине процессора гомерически хохочет оптимизатор GCC. Однако, для реально критичных мест - только измерения.		Если после этого глубокой ночью в тёмном-тёмном лесу запустить компиляцию и прислушаться, можно услышать как в глубине процессора гомерически хохочет оптимизатор GCC. Однако, для реально критичных мест - только измерения.
		+
		+	=== F.6: Если функция не может бросать исключения, объявить её noexcept ===
		+
		+	Noexcept говорит компилятору о том, что в данной функции не может быть исключений, которые надо каким-то образом обрабатывать, это уменьшает количество альтернативных путей выполнения и ускоряет завершение после крэша. Например, в чистом C или ассемблере исключений нет в принципе, т. о., такие функции стоит объявить noexcept.
		+
		+	Функции constexpr могут бросать исключение в рантайме, т. о., noexcept может применяться и к ним.
		+
		+	Наиболее оптимально применение noexcept к коротким и часто вызываемым функциям.
		+
		+	Дефолтные конструкторы, деструкторы, операции move и swap не должны бросать исключений. См. также C.44.
		+
		+	=== F.7: Предпочитать аргументы T* / T& смарт-поинтерам ===
		+
		+	Смарт-поинтеры тянут дополнительную нагрузку на проц, поэтому использовать их имеет смысл только если нужна семантика владения. См. также R.30, F.60.
		+
		+	=== F.8: Предпочитать чистые функции ===
		+
		+	Чистая функция возвращает одно и то же значение для одного и того же набора аргументов. Возврат не зависит ни от каких внешних факторов (глобальные переменные, время и т. п.). Простейший пример - использование чистой функции strlen в конструкции for (auto i=0; i<strlen(s); i++) исключит вызов strlen в каждой итерации, результат будет вычислен один раз в начале цикла. Для GCC функция маркируется атрибутом pure: __attribute__ ((pure)) int strlen(char* s).
		+
		+	=== F.9: Не именовать неиспользуемые параметры ===
		+
		+	Например, если в переопределённом методе класса-наследника какой-то параметр метода родителя не используется, указание типа без имени подавляет варнинги о неиспользованных переменных: int myClass::dosmth(int used, int).
		+
		+	== F.call: Передача аргументов ==

@@ Строка 284: / Строка 284: @@
 == F: Функции ==
-Функция - это действие, которое переводит систему из одного состояния в другое. Это базовые "кирпичики", из которых строится программа. Функция нужно осмысленно назвать, определить требования к аргументам и чётко установить связь между аргументами и результатом. Реализация и определение - это две равнозначные задачи, необходимо продумать определение так же тщательно, как и реализацию. Функции - наиболее критичная часть в большинстве интерфейсов.
+Функция - это действие, которое переводит систему из одного состояния в другое. Это базовые "кирпичики", из которых строится программа. Функцию нужно осмысленно назвать, определить требования к аргументам и чётко установить связь между аргументами и результатом. Реализация и определение - это две равнозначные задачи, необходимо продумать определение так же тщательно, как и реализацию. Функции - наиболее критичная часть в большинстве интерфейсов.
 === F.1: Упаковывать операции в функции с говорящими именами ===

@@ Строка 280: / Строка 280: @@
 === I.30: Инкапсулировать опасный код ===
-Иногда (например, в целях повышения производительности) приходится писать код, потенциально опасный для стабильности программы. Например, в простой функции, многократно выполняемой в цикле, целесообразно убрать проверку валидности входных данных, это даст заметный прирост производительности. Но в этом случае функцию нужно завернуть в класс, который, например, проверит начальное и конечное значение цикла. Это, во-первых, позволит сохранить безопасность кода, во-вторых - избавит всех  остальных программистов, которые будут взаимодействовать с вашим кодом, помнить о нюансах работы с ним.
+Иногда (например, в целях повышения производительности) приходится писать код, потенциально опасный для стабильности программы. Например, в простой функции, многократно выполняемой в цикле, целесообразно убрать проверку валидности входных данных, это даст заметный прирост производительности. Но в этом случае функцию нужно завернуть в класс, который, например, проверит начальное и конечное значение цикла. Это, во-первых, позволит сохранить безопасность кода, во-вторых - избавит всех  остальных программистов, которые будут взаимодействовать с вашим кодом, от необходимости помнить о нюансах работы с ним.
 == F: Функции ==