В качестве style-guide в нашей команде используются следующие документы:
-
NYTimes Objective-C Style Guide
Очень подробный style guide, отвечающий на большую часть спорных вопросов. Для того, чтобы не писать свой велосипед, в определенный момент времени мы приняли решение в спорных вопросах обращаться именно к нему.
-
The Book of VIPER / Вопросы Code Style
Когда мы только начали использовать VIPER, терминология во всех проектах очень сильно различалась. Чтобы избавиться от этого, мы написали свой небольшой гайд по неймингу и оформлению кода в рамках VIPER-модуля.
-
Rambler Swift Style Guide (ru | en) - в разработке
Подробный style guide, решающий большинство спорных вопросов, возникающих при разработке на языке swift. Его использование призвано повысить единообразие решений между проектами и увеличить читабельность кода.
Относительно комментирования мы приняли несколько дополнительных правил.
Код должен быть быть самодокументированным, все неочевидные вещи должны быть описаны комментариями. Комментарии пишутся на русском языке. Формат комментариев:
-
однострочные
// Текст комментария -
многострочные
/** Текст комментария Текст комментария */
Для комментариев или заметок не разрешается использоваться #warnings. Если необходимо пометить место, например, для будущего рефакторинга, необходимо использовать комментарии вида // TODO: Текст комментария.
Для операций, связанных с API, нужно указывать ссылки на исходную документацию вида @see http://api.com.
При использовании каких-либо workaround’ов необходимо указывать ссылку на радар/stackoverflow вида @link http://stackoverflow.com/questions/8457847/ios-core-data-when-to-save-context.