Skip to content

Code style in project OpenPapyrus

sobolev edited this page Feb 26, 2018 · 8 revisions

Общие правила

Примеры кода

Дакларация класса

//
// Descr: Комментарий к классу (первая строка)
//   продолжение комментария к классу на следующей строки с отступом в 2 пробела.
//
class Cls : public BaseCls {
public:
	Cls();
	int    MemberFunc01(long * pID, const void * pData, size_t dataLen);
	int    MemberFunc02(long id);
	const void * MemberFunc03(long id, size_t * pDataLen) const;
private:
	virtual void VirtualMemberFunc04(void * pItem);

	long   LastId;
};

Этот пример демонстрирует следующие особенности:

  • Наименования классов и структур начинается с прописной буквы
  • Наименования членов классов и структур так же начинаются с прописных букв
  • Открывающая скобка { для декларации находится на той же строке, что и наименование декларации
  • Ключевые слова public, private, protected для членов класса стартуют с той же позиции строки, что и ключевое слово class (struct, union, enum)

Отступы

Для отступов в тексте кодов применяется символ табуляции. Кроме как в начале строки символы табуляции не должны нигде более использоваться (разделение между токенами внутри строки - только пробелы).

Clone this wiki locally