Янв
26
Ещё 3 правила именования функций
Категория: Культура кода Автор: Александр Никитин Опубликовано: 26-01-2010
Метки: правила именования, функции
В предыдущей статье я описал основные 5 правил, которыми следует руководствоваться при именовании функций. Теперь же хочу рассказать не только о функциях, но и о процедурах (функциях, которые ничего не возвращают).
- Для именования процедуры используйте глагол и название объекта. Обычно процедуры выполняют некоторую работу над объектами программы. Соответственно, наилучшим именем для них будет название действия, которое они делают, плюс объект, над которым производится работа. Примеры удачных названий: RemoveOldMessages(), ChangeBackgroundColor() и т.п.
- Используйте антонимы. В программировании уже давно сформировались пары слов, которые обычно вместе встречаются в названиях функций и методов. Например: get/set, open/close, show/hide, start/stop, add/remove и т.д. Старайтесь использовать парные методы, где это имеет смысл. Также соблюдайте зеркальность таких функций: FileOpen – FileClose, WindowShow – WindowHide, а не FileOpen – fClose, WinShow – HideWndw.
- Выработайте правила именования часто используемых операций. Предположим, все объекты в системе имеют уникальный идентификатор. Тогда со временем у разных классов может появиться целый ряд методов для получения идентификатора. Например,
Object.id.get()
Employee.getId()
Agent.parent.id()
Если вы заранее можете сказать, что идентификатор является свойством абсолютно всех сущностей разрабатываемой системы, то следует с самого начала определить формат и имена функций для работы с ним. Например, <объект>.GetId() – для получения, <объект>.SetId(int Id) – для установки.
P.S. Напоследок хочу поделиться ссылкой на очень прикольную игру, написанную в 90-х годах. Вот где действительно нужно было проявлять искусство программирования. 82FAJGW4J38R





