Загальні положення 4 Частина Основи мови С++ 9

Стандарт оформлення коду (Code Conventions)

1. 
   Всі назви та імена в програмі повинні бути осмислені та зрозумілі. У загальному випадку використовувати стиль UpperCamelCase для найменування класів і методів і lowerCamelCase для найменування екземплярів класів і змінних.
   

Використовувати префікси:

• 
  назва класу з префіксом «C» (наприклад, «class CStudent»);
  
• 
  назва атрибутів (полів) з префіксом «i» (наприклад, «int iSomeAttribute»);
  
• 
  назва параметрів методів і функцій з префіксом «a» (наприклад, «void SomeMethod(int aSomeParam)»);
  
• 
  константи з префіксом «K» (наприклад, «const int KConstValue = 10»).
  

2. 
   Коментувати усі класи, методи і атрибути.
   
3. 
   Дружні елементи розміщувати на початку класа без зазначення рівня доступу.
   
4. 
   Конструктори і деструктор розміщувати на початку класа після «друзів», як що вони є.
   
5. 
   Поля відокремлювати від методів і операторів. Кожен атрибут (поле) розміщувати в окремій строчці. Таким чином атрибути можуть бути зручно прокоментовані.
   

int iCorrectName; // Так

int iIncorrNm; // Ні
int iOceanName, iOceanDepth; // Ні
int iOceanName; // Так
int iOceanDepth;

6. 
   Загальні рекомендації:
   

• 
  код будь-якого методу не може бути довгим. Зазвичай він не займає більше ніж один екран;
  
• 
  макроси мови програмування С не використовуються;
  
• 
  глобальні змінні в більшості випадків не використовуються (виключенням можуть бути, наприклад, константні строки).
  

7. 
   Кожний розроблений клас має бути розміщений в окремій парі файлів cpp/h:
   

• 
  об’явлення (інтерфейс) класу в h-файлі (заголовний файл, файл що включається, header-файл);
  
• 
  реалізація класу в .cpp-файлі (модуль, що компілюється);
  
• 
  імена файлів відповідають назві класу (наприклад, «One.h», «One.cpp»);
  
• 
  header-файли мають бути захищені від багаторазового включення за допомогою конструкції вида
  

#ifndef FILENAME_H

#define FILENAME_H
…
#endif

або директиви

#pragma once

Загальний приклад об’явлення класу в файлі «MyClass.h»

#pragma once

#include «BaseClass.h»

class COtherClass;

/**
* Comment

*/
class CMyClass: public CBaseClass {
public:

/**
* Comment

*/
CMyClass();

/**
* Comment

* @param aSomeParameter Comment
* @return Comment
*/
int SomeMethod(int aSomeParameter);

private:

/// Comment
COtherClass* iOtherClass;

/// Comment

int iInternalValue;

};