×
Namespaces

Variants
Actions

Соглашения об именах

From Nokia Developer Wiki
Jump to: navigation, search
Article Metadata

Статья
Автор: Den123 (12 Jul 2007)
Последнее редактирование: hamishwillee (10 Nov 2011)

При разработке приложений для Symbian ОС используются следующие правила именования:

Contents

Переменные

  • Имена данных-членов должны начинаться с прописной буквы i.
  • Имена аргументов функций должны начинаться с прописной буквы a.
  • Имена локальных переменных не должны содержать префикса.
  • Глобальные переменные обычно не используются, но, если используются, их имена должны начинаться с заглавной буквы.

В Symbian не используется венгерская (или какая-либо) другая нотация именования.


Классы

Имена классов могут начинаться со следующих заглавных букв-префиксов: C, T, R, M. Префикс обозначает тип класса. Типы классов описаны здесь. Если класс содержит только набор статических функций - его имя не должно иметь префикса (например класс User). Обычно, имя класса (если отбросить префикс) - это существительное которое описывает его назначение.


Структуры

Имена структур могут начинаться с префиксов: T и реже S. По своей природе структуры очень похожи на T-классы, они не владеют внешними объектами.


Функции

Имя функции должно описывать то, что эта функция делает. Обычно это глагол (за исключение функций-геттеров).

  • Функции-геттеры (getter functions), возвращающие значения данных-членов обычно имеют такое же имя, что и сама переменная без префикса i. Пример:
inline TType Type() { return iType; }
  • Имена Функций-сеттеров (setter functions) должны начинаться со слова Set, например SetType().
  • Имена сбрасываемые функции должны оканчиваться на букву L, например NewL(). Что такое сброс можно прочитать здесь.
  • Имена функций, которые заносят созданный объект в стек очистки должны оканчиваться буквой C. Обычно, такие функции являются сбрасываемыми - соответственно имена таких функций должны оканчиваться на LC, например NewLC().
  • Имена функций, которые в результате выполнения уничтожают собственный объект, должны оканчиваться буквой D.
CAknInformationNote* note = new ( ELeave ) CAknInformationNote( ETrue );
note->ExecuteLD( text );
Функция ExecuteLD выполняет вторую фазу конструирования, запускает диалог, после чего уничтожает его.


Макросы

Имена макросов должны состоять из заглавных букв, слова разделяются символом подчеркивания.


Перечисления (enums)

Имена самих перечислений должны начинаться с буквы T, имена элементов перечисления - с буквы E. Желательно объявляться перечисления в рамках использующего класса, чтобы не засорять глобальное пространство имен. Пример:

class TBranchOperation
{
public:
enum TType
{
EUnknown,
EDriveInfo,
EDriveList,
EDirInfo
};
};
TBranchOperation::TType type = TBranchOperation::EUnknown;


Константы

Имена констант должны начинаться с заглавной буквы K. Например:

const TInt KMachineConfigurationMajorVersionNumber=1;


Внешние ссылки

Symbian Naming conventions.

This page was last modified on 10 November 2011, at 06:17.
39 page views in the last 30 days.
×