The Swift Programming Language (Swift 4) / Swift 4: API Design Guidelines

Оглавление

Сбросить всё

←

→

Английский оригинал	Перевод на русский
Сожалеем, но текст оригинала доступен только зарегистрированным пользователям.	Основы trambalda 25.08.17 в 12:12 0
	Понятность кода является самой важной вашей целью. Методы и свойства объявляются всего один раз, а используются очень часто. Разрабатывайте API так, чтобы сделать их использование понятным и лаконичным. При разработке прочтение объявления редко является достаточным; всегда проверяйте насколько понятно все выглядит в контексте. trambalda 25.08.17 в 12:15 0
	Понятность кода намного важнее краткости. Несмотря на то, что Swift может быть очень компактным, нет задачи создать код с минимально возможным количеством символов. Краткость в Swift, это побочный эффект, получаемый из-за строгой типизации и свойств языка, которые естественным образом уменьшают объем кода. trambalda 25.08.17 в 12:33 0
	Документируйте через комментарии каждое объявление. Пересмотр кода, осуществляемый во время написания документации, может оказать сильное влияние на качество вашего кода, поэтому не пренебрегайте этим. trambalda 25.08.17 в 12:35 0
	Если вы затрудняетесь описать API простыми словами, возможно, вы спроектировали плохой API. trambalda 25.08.17 в 12:36 0
	Используйте разновидность разметки, принятую в Swift: https://developer.apple.com/library/prerelease/mac/documentation/Xcode/Reference/xcode_markup_formatting_ref/ trambalda 25.08.17 в 12:37 0

Следующая страница →