Axon

Наколеночная операционная система.

Axon - рабочее название. Пусть пока будет так. Потом придумаем нормальное.

Организационные моменты

У каждой фичи есть своя ветка. Коммитим туда. Рабочие сборки пушим в dev.

В master пушим релизы.

В целом, поаккуратнее с гитом, чтобы ничего не сломать.

CodeStyle

Простенькое соглашение об именовании функций и переменных и стиле написания кода в нашем чудесном проекте.

В CLion настроен файл кодстайла. Тыкайте Ctrl+Alt+L.

Используется PascalCase.

Наименования классов, структур, юнионов, перечислений пишутся с большой буквы. Функции и методы - с большой буквы.

Переменные - с маленькой буквы. Переменные должны иметь осмысленные названия. В качестве счетчиков цикла можно использовать однобуквенные i, j, k, если их значение очевидно, либо сопровождается комментарием.

Глобальные переменные и статические non-private члены классов - с большой буквы. MyGlobalVar

Public члены классов -- с большой буквы. MyPublicMethod()

Protected члены классов -- начинаются с большой буквы. MyProtectedVar

Приватные поля классов (методы, переменные и проч.) начинаются с буквы m. mPrivate

Private методы классов -- начинаются с маленькой буквы. privateMethod()

Константы пишутся большими буквами, разделение слов знаком подчеркивания. MY_CONSTANT

Открывающая фигурная скобка ставится без переноса строки, через один пробел. Закрывающая фигурная скобка ставится на отдельной строке.

Код внутри фигурных скобок (тело функции, цикла, проч.) сдвигается на один таб (4 пробела).

Пример кода:

#define EXAMPLE_MACROS 1

int GlobalVariable;
const int MY_CONSTANT = 0;

class MyClass : public SomeClass {
public:
	static int MyStaticMethod();
	static float MyStaticVariable;
	int MyVariable;
	double MyMethod();
protected:
    int MyProtectedMethod();
    float MuProtectedVariable;
private:
	static float mPrivateStaticVariable;
	int mMyPrivateVariable;
	void myPrivateMethod();
	struct MyPrivateStruct {
		int a;
	};
};

void MyFunction() {
	int variable;
}

Doxygen

Документация складируется в папку docs. Обновляйте ее перед коммитом.

Must Read

• Аблязов Руслан Зуфярович, Программирование на ассемблере на платформе х86-64
• Таненбаум Эндрю, Операционные системы. Разработка и реализация
• Форум по разработке операционных систем
• Вики по архитектурам операционных систем
• Вики по операционным системам