Кодирование соглашений
Кодирующие соглашения являются рядом инструкций, помогающих гарантировать эффективность и непротиворечивость в использовании API и ясности и непротиворечивость в именовании API. Если Вы после соглашений использования в Вашем коде, Вы, менее вероятно, испытаете проблемы, такие как исключения на этапе выполнения. Если Вы будете придерживаться соглашений о присвоении имен, то любые методы, функции, константы или другие символы, которые Вы объявляете, будут лучше поняты под разработчиками, которые должны работать с Вашим кодом.
Методы, определенные в платформах Какао — например, Основа, AppKit и UIKit — ведут себя определенными способами при различных обстоятельствах. Например:
Методы это эхо-сигналы обычно возвращаются
nil
если они не могут создать или найти объект. Они непосредственно не возвращают код состояния.Методы, выполняющие работу, возвращают булево значение для указания успешности или неуспешности.
Если метод берет объект коллекции — т.е.
NSArray
,NSDictionary
, илиNSSet
объект — как параметр, не указыватьnil
указать «значение по умолчанию» или “никакое значение”; вместо этого, передайте в пустом объекте коллекции.Если Вы явно управляете памятью программ, следуете инструкциям и методам для управления памятью.
Вот выборка соглашений о присвоении имен API:
Ясность и краткость оба важны, но ясность никогда не должна приноситься в жертву за краткость.
Избегите имен, которые неоднозначны.
Используйте глаголы на имена методов или функций, представляющих действия.
Используйте префиксы для имен классов и для символов, связанных с классом, таких как функции и типы данных.