Solution.codestyle.hpp

 
{
  // ...
}
  
/*static*/ void ClassName::DoProcess(void) 
{
  // ...
}
 
* \endcode
*  - В определении функции сначала ставить входные, затем выходные параметры.
*  - Параметры, являющиеся результатом работы функции должны передаваться через 
*  указатели(ссылки - только константные!).
*  - Параметры, являющиеся результатом работы функции, должны быть помечены 
*  комментарием \b out
* \code
 
void GetValue(/*out*/ int * _pValue);
 
* \endcode
*  
*  Правила именования переменных/функций/классов/файлов
*  ----------------------------------------------------
*  
*  - Имена переменных должны быть существительными, функций - 
*  глаголами/командами.
*  - Имена файлов должны совпадать с именами объявленных в них классов (включая 
*  пространство имен).
*  - \ref IdentifiersAnchor "Правила именования идентификаторов".
*  
*  Пространства имен
*  -----------------
*  
*  - Каждый отдельный модуль программы должен иметь свое пространство имен.
*  - Не использовать директиву using namespace вне функций.
*  - Пространство имен должно завершаться комментарием "} // namespace <name>".
*  - Код внутри пространства имен должен идти по левому краю.
*  - Вместо статических констант использовать константы в не именованных 
*  пространствах имен (использовать их в заголовочных файлах только для 
*  объявления констант!).
*  
*  Конструкторы/деструкторы
*  ------------------------
*  
*  - Всегда явным образом определять конструктор по умолчанию, инициирующий 
*  внутренние переменные класса.
*  - Использовать ключевое слово explicit для конструкторов с одним аргументом.
*  - Если класс не имеет явного конструктора копирования, наследовать его от 
*  boost::noncopyable.
*  - Деструктору всегда явным образом указывать noexcept.
*  
*  Примеры
*  =======
*  
* \anchor Example1Anchor
*  
*  Пример 1: Перечисления
*  ----------------------
*  
* \code
 
// Объявление:
class Status
{
public:
  enum Value : size_t
  {
    Unknown = 0,
    Play,
    Pause,
    Stop,
      
    Illegal
  };
};
  
// Использование
Status::Value CurrentStatatus = Status::Stop;
 
* \endcode
*  
*  Пример 2: Константы
*  -------------------
*  
* \code
 
namespace 
{
  
// Объявление
template<class T>
class Constant final
{
public:
  static constexpr T PI = static_cast<T>(math::PI);
};
  
} // unnamed namespace
  
// Использование
auto DoublePI = 2.0f * Constant<float>::PI;
 
* \endcode
*  
* \anchor Example2Anchor
*
*  Пример 3: Именование параметров
*  -------------------------------
*  
* \code
 
const bool IsSsuccess = CalculateSomething(InterestingValue,
  10,
  false,
  NULL); // Что означают все эти аргументы??
 
* \endcode
*  
*  вместо:
*  
* \code
 
const bool IsSuccess = CalculateSomething(InterestingValue,
  10,       // Базовое значение по умолчанию
  false,    // Функция вызывается не в первый раз.
  nullptr); // Без возвратной функции.
 
* \endcode
*  
*  Или, в качестве альтернативы, используя константы или само-описывающие переменные:
*  
* \code
 
const int DefaultBaseValue = 10;
const bool IsFirstTimeCalling = false;
Callback * fnNullCallback = nullptr;
  
const bool IsSuccess = CalculateSomething(InterestingValue,
  DefaultBaseValue,
  IsFirstTimeCalling,
  fnNullCallback);
 
* \endcode
*  
*  Под вопросом
*  ============
*  
*  - Запятые в списке инициализации переменных в конструкторе ставить после 
*  переменной.
*  - Вместо \<iostream\> в заголовочных файлах писать \<iosfwd\> для ускорения 
*  компиляции.
*  - Для быстрого копирования потоков ввода - вывода(из одного в другой), 
*  использовать функцию потока .rdbuf() (cout << file.rdbuf()).
*  - С помощью функции std::uncaught_exception можно проверить, как завершает 
*  работу функция: это нормальный возврат или было выброшено исключение.
*  - Преобразовывайте тип числа с плавающей точкой в целочисленный тип 
*  исключительно через функции стандартной библиотеки(«round», «floor», «ceil» 
*  и т.п.)
*  - Для инициализации переменных использовать списки инициализации (они не 
*  позволяют сужение типов: int x1 = { 7.3 }; //compilation error).
*  - Профайлер не может подсказать, какие inline функции не должны быть 
*  встраиваемыми!
*  - Строки хранить в отдельном файле (лучше.cpp).
*  - Исключение не должно покидать деструктор (особенно это касается работы 
*  с контейнерами STL).
*  - Для класса предоставлять функцию swap() (она должна быть бессбойной!), 
*  которую можно использовать для присваивания со строгими гарантиями 
*  безопасности (для примитивных типов использовать std::swap())
* \code
 
T & T::operator= (T Temp) // По значению!
{
  swap(Temp);
  return *this;
}
 
* \endcode
*  - Для отсортированного набора объектов можно использовать индексные 
*  контейнеры, содержащие итераторы на основной контейнер.
*  - Для добавления элементов в контейнер предпочтительнее использовать операции 
*  с диапазонами.
*  - container<T>(c).swap(c); // Удаление всей лишней (зарезервированной) 
*  емкости контейнера.
*  - container<T>().swap(c); // Удаление всех элементов и очистка памяти 
*  контейнера.
*  - find / find_if и count / count_if - поиск в неотсортированном диапазоне.
*  - lower_bound, upper_bound, equal_range(реже binary_search) - поиск 
*  в отсортированном диапазоне.
*  - Функциональные объекты должны содержать константный operator().
*  - Побочные подзадачи выделять в отдельный код.
*/