🔍 Начните печатать, чтобы искать по книге или перейти к нужной странице по номеру
Удобно листать не только прокруткой, но и клавишами‑стрелками:
Представляем практическое руководство по редактуре текста в информационном стиле. Учебник предназначен для писателей, редакторов, дизайнеров, разработчиков и менеджеров.
Слово 4
Предложение 57
Абзац 105
Текст 127
Представляем практическое руководство по редактуре текста в информационном стиле. Учебник предназначен для писателей, редакторов, дизайнеров, разработчиков и менеджеров.
Слово 4
Предложение 57
Абзац 105
Текст 127
Параллельность. В сложных объяснениях, правилах, длинных инструкциях и манифестах помогает вводить внутреннюю структуру каждого элемента.
Принципы оформления кода написаны вразнобой: одни в повелительном наклонении, другие — от третьего лица. Есть даже предложение, в котором по отношению к читателю одновременно используется и третье лицо, и повелительное наклонение.
Сами абзацы тоже плохо структурированы: где‑то они начинаются с ключевых слов, будто это подзаголовки; где‑то — с повелительного наклонения.
Попробуем привести этот манифест в порядок.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика есть выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.
Параллельность. В сложных объяснениях, правилах, длинных инструкциях и манифестах помогает вводить внутреннюю структуру каждого элемента.
Принципы оформления кода написаны вразнобой: одни в повелительном наклонении, другие — от третьего лица. Есть даже предложение, в котором по отношению к читателю одновременно используется и третье лицо, и повелительное наклонение.
Сами абзацы тоже плохо структурированы: где‑то они начинаются с ключевых слов, будто это подзаголовки; где‑то — с повелительного наклонения.
Попробуем привести этот манифест в порядок.
Чтобы привести в порядок этот текст, возьмём за основу единую структуру для каждого правила:
Принцип — утверждение
Рекомендация — повелительное наклонение
Объяснение — в свободной форме, по желанию
Применим структуру к первому абзацу текста: принцип, рекомендация, объяснение.
Распространим на все абзацы.
Принципы‑утверждения в начале абзацев не согласованы. Хочется привести их к единому формату и сделать более звонкими.
Первый вариант — превратить все принципы в выражения с глаголом в неопределённой форме. Получается что‑то вроде советов, но не везде это выглядит элегантно.
Другой вариант — обозначить, о чём правило. Выглядит элегантнее.
В двух абзацах после основного совета есть исключения. Зададимся вопросом: какие исключения у других правил? Общая для всех правил структура поможет нам увидеть белые пятна.
Теперь все правила организованы единообразно:
Ключевое слово — существительное
Совет — повелительное наклонение
Исключение — повелительное наклонение
Объяснение — в свободной форме, по желанию
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только 4 пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступайте только 4 пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступайте только 4 пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступайте только 4 пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступ — 4 пробела. Отступайте табуляцией только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Экономить пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Одни кавычки навсегда. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Следить за пробелами. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте — вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступ — 4 пробела. Отступайте табуляцией только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Экономить пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Одни кавычки навсегда. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Следить за пробелами. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Следить за читаемостью. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступать 4 пробелами. Отступайте табуляцией только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Экономить пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Использовать одни кавычки. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Следить за пробелами. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Читаемость. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступы. Отступайте 4 пробелами. Используйте табуляцию только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Кавычки. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Пробелы. Не ставьте внутри скобок, перед запятой, точкой с запятойли двоеточия; ставьте вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Читаемость. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступы. Отступайте 4 пробелами. Используйте табуляцию только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Кавычки. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Пробелы. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Читаемость. Пишите код так, чтобы его было удобно читать незнакомым людям. Если читаемость вредит скорости разработки, всё равно выбирайте читаемость. Вы пишете код один раз, а после вас его читают десятки раз.
Отступы. Отступайте 4 пробелами. Используйте табуляцию только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. В крайнем случае отбивайте смысловые блоки функций двумя строками. Пустые строки — инструмент смыслового деления кода.
Кавычки. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Пробелы. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте вокруг операторов. В сложных ситуациях поступайте последовательно.
Принципы оформления кода
Читаемость важна. Мы исходим из того, что код читают гораздо чаще, чем пишут. Поэтому оформление должно быть понятным и стандартизированным — так посторонний разработчик сможет разобраться в том, что делает код.
Отступайте только 4 пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступайте только 4 пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступайте только 4 пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступайте только 4 пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступайте только четырьмя пробелами. Отступать табуляцией можно только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости.
Пустые строки. Функции верхнего уровня и определения классов отбиваются двумя пустыми строками. Методы внутри класса отбиваются одной пустой строкой. Используйте пустые строки экономно.
Язык позволяет одинаково равноценно использовать одинарные и двойные кавычки. Выберите что‑то одно и используйте последовательно. Если у разработчика стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, лучше смените формат: экранирование хуже читается.
Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступ — 4 пробела. Отступайте табуляцией только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Экономить пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Одни кавычки навсегда. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Следить за пробелами. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте — вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Читаемость важна. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступ — 4 пробела. Отступайте табуляцией только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Экономить пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Одни кавычки навсегда. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Следить за пробелами. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Следить за читаемостью. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступать 4 пробелами. Отступайте табуляцией только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Экономить пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Использовать одни кавычки. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Следить за пробелами. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Читаемость. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступы. Отступайте 4 пробелами. Используйте табуляцию только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Кавычки. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Пробелы. Не ставьте внутри скобок, перед запятой, точкой с запятойли двоеточия; ставьте вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Читаемость. Пишите код так, чтобы его было удобно читать незнакомым людям. Код читают чаще, чем пишут.
Отступы. Отступайте 4 пробелами. Используйте табуляцию только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.
Кавычки. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Пробелы. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте вокруг операторов. Пробелы должны использоваться последовательно.
Принципы оформления кода
Читаемость. Пишите код так, чтобы его было удобно читать незнакомым людям. Если читаемость вредит скорости разработки, всё равно выбирайте читаемость. Вы пишете код один раз, а после вас его читают десятки раз.
Отступы. Отступайте 4 пробелами. Используйте табуляцию только тогда, когда остальной код уже написан с табуляцией и возникает вопрос совместимости. В остальных случаях отступайте пробелами.
Пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. В крайнем случае отбивайте смысловые блоки функций двумя строками. Пустые строки — инструмент смыслового деления кода.
Кавычки. Для строк выберите одинарные или двойные кавычки и используйте последовательно. Если у вас стоит выбор, сменить формат кавычек или экранировать кавычки внутри строки, смените формат: экранирование хуже читается.
Пробелы. Не ставьте пробелы внутри скобок, перед запятой, точкой с запятой или двоеточия; ставьте вокруг операторов. В сложных ситуациях поступайте последовательно.
Чтобы привести в порядок этот текст, возьмём за основу единую структуру для каждого правила:
Принцип — утверждение
Рекомендация — повелительное наклонение
Объяснение — в свободной форме, по желанию
Применим структуру к первому абзацу текста: принцип, рекомендация, объяснение.
Распространим на все абзацы.
Принципы‑утверждения в начале абзацев не согласованы. Хочется привести их к единому формату и сделать более звонкими.
Первый вариант — превратить все принципы в выражения с глаголом в неопределённой форме. Получается что‑то вроде советов, но не везде это выглядит элегантно.
Другой вариант — обозначить, о чём правило. Выглядит элегантнее.
В двух абзацах после основного совета есть исключения. Зададимся вопросом: какие исключения у других правил? Общая для всех правил структура поможет нам увидеть белые пятна.
Теперь все правила организованы единообразно:
Ключевое слово — существительное
Совет — повелительное наклонение
Исключение — повелительное наклонение
Объяснение — в свободной форме, по желанию
В устной речи у автора нет элегантного способа обозначить тему рассказа. Он вынужден говорить «а теперь мы перейдём к...» или «рассмотрим такую‑то тему». Это неизбежно в лекции или на личной встрече, но на письме легче воспользоваться заголовком.
Заголовок сообщает, что текст под ним посвящён определённой теме. Он помогает найти нужную часть текста, кратко объяснить логику длинного текста и просто привлечь внимание. А в особенно смелых изданиях заголовок становится местом творческих экспериментов.
Редактор должен стремиться поставить заголовок к статье, промостранице, тексту о себе, публикации в Фейсбуке, даже к СМС или пуш‑уведомлению. Это не только сделает текст привлекательнее, но и сработает как проверка: если редактор не может подобрать заголовок, то у текста проблема со структурой и логикой.
Всегда ставьте заголовки
В устной речи у автора нет элегантного способа обозначить тему рассказа. Он вынужден говорить «а теперь мы перейдём к...» или «рассмотрим такую‑то тему». Это неизбежно в лекции или на личной встрече, но на письме легче воспользоваться заголовком.
Заголовок сообщает, что текст под ним посвящён определённой теме. Он помогает найти нужную часть текста, кратко объяснить логику длинного текста и просто привлечь внимание. А в особенно смелых изданиях заголовок становится местом творческих экспериментов.
Редактор должен стремиться поставить заголовок к статье, промостранице, тексту о себе, публикации в Фейсбуке, даже к СМС или пуш‑уведомлению. Это не только сделает текст привлекательнее, но и сработает как проверка: если редактор не может подобрать заголовок, то у текста проблема со структурой и логикой.
Всегда ставьте заголовки
Заголовок помогает привлечь внимание к тексту или его части. Короткий текст, набранный бóльшим кеглем или жирным начертанием и стоящий на отдельной строке, выглядит как заголовок. Читатель обращает на него внимание автоматически.
Несмотря на то, что обычно мы читаем слева направо, на этом развороте вы сначала познакомились с примером справа. Мощный крупный заголовок перетянул на себя внимание и нарушил естественный порядок чтения.
Однако заметным заголовок делает не размер, не жирность, а контраст с обычным текстом. Если набрать весь текст крупно, контраст пропадёт и текст перестанет быть привлекательным.
Проектируйте заголовки так, чтобы читатель на них отдыхал. Достаточно поставить заголовок к статье и разбавлять её подзаголовками после каждых 7—10 абзацев текста.
Если ставить заголовки слишком часто, читатель устанет от смены формата.
Вы прочитали заголовок раньше всего на этом экране, потому что он выделялся на общем фоне. Чисто графически заголовок доминирует среди окружения и приковывает взгляд.
Теперь этот текст выглядит менее привлекательно, потому что он больше не похож на заголовок. Здесь много текста, а контраста больше нет. А из‑за жирных и коротких строк этот текст читать менее удобно, чем тот, что слева.
Дайте глазам отдохнуть
Хорошо спроектированный заголовок даёт читателю отдохнуть: он короткий, контрастный и окружён основным текстом. Слишком длинные или частые заголовки будут мешать.
Хорошо спроектированный заголовок даёт читателю отдохнуть.
Избегайте конфликтов
Заголовки не должны конфликтовать друг с другом и основным текстом.
Короткий и контрастный
Хороший заголовок должен занимать не более полутора строк, сильно отличаться по размеру и начертанию от основного текста и находиться в окружении этого текста, а не других заголовков
Это отвлекает
Слишком длинные и частые заголовки будут мешать.
И от этого устаёшь
Чтение и так сложный процесс. Каждый раз, когда читателю придется переключаться на другой формат текста, он будет совершать дополнительные усилия.
Окружайте заголовок текстом
Следите, чтобы заголовки не стояли слишком близко.
Вы прочитали заголовок раньше всего на этом экране, потому что он выделялся на общем фоне. Чисто графически заголовок доминирует среди окружения и приковывает взгляд.
Теперь этот текст выглядит менее привлекательно, потому что он больше не похож на заголовок. Здесь много текста, а контраста больше нет. А из‑за жирных и коротких строк этот текст читать менее удобно, чем тот, что слева.
Дайте глазам отдохнуть
Хорошо спроектированный заголовок даёт читателю отдохнуть: он короткий, контрастный и окружён основным текстом. Слишком длинные или частые заголовки будут мешать.
Хорошо спроектированный заголовок даёт читателю отдохнуть.
Избегайте конфликтов
Заголовки не должны конфликтовать друг с другом и основным текстом.
Короткий и контрастный
Хороший заголовок должен занимать не более полутора строк, сильно отличаться по размеру и начертанию от основного текста и находиться в окружении этого текста, а не других заголовков
Это отвлекает
Слишком длинные и частые заголовки будут мешать.
И от этого устаёшь
Чтение и так сложный процесс. Каждый раз, когда читателю придется переключаться на другой формат текста, он будет совершать дополнительные усилия.
Окружайте заголовок текстом
Следите, чтобы заголовки не стояли слишком близко.
Заголовок помогает привлечь внимание к тексту или его части. Короткий текст, набранный бóльшим кеглем или жирным начертанием и стоящий на отдельной строке, выглядит как заголовок. Читатель обращает на него внимание автоматически.
Несмотря на то, что обычно мы читаем слева направо, на этом развороте вы сначала познакомились с примером справа. Мощный крупный заголовок перетянул на себя внимание и нарушил естественный порядок чтения.
Однако заметным заголовок делает не размер, не жирность, а контраст с обычным текстом. Если набрать весь текст крупно, контраст пропадёт и текст перестанет быть привлекательным.
Проектируйте заголовки так, чтобы читатель на них отдыхал. Достаточно поставить заголовок к статье и разбавлять её подзаголовками после каждых 7—10 абзацев текста.
Если ставить заголовки слишком часто, читатель устанет от смены формата.
В выпусках новостей на радио используют предварительно записанные голосовые вставки — они выполняют роль заголовков. Обычно они выбиваются из общего потока речи: например, новости читает девушка, а вставки записал мужчина. За счёт непохожести слушатель отличает их и на лету выхватывает структуру рассказа.
...и засунуть себе
куда подальше
Другие сотрудники
от комментариев
отказались.
О погоде!
В Москве солнечно,
без осадков,
градуса.
О пробках!
Плотно стоит
третье кольцо
...и засунуть себе
куда подальше
Другие сотрудники
от комментариев
отказались.
О погоде!
В Москве солнечно,
без осадков,
градуса.
О пробках!
Плотно стоит
третье кольцо
В выпусках новостей на радио используют предварительно записанные голосовые вставки — они выполняют роль заголовков. Обычно они выбиваются из общего потока речи: например, новости читает девушка, а вставки записал мужчина. За счёт непохожести слушатель отличает их и на лету выхватывает структуру рассказа.
Ильяхов Максим Олегович
Информационный стиль
Арт‑директор и издатель Артём Горбунов
Иллюстратор Андрей Кокорин
Дизайнер обложки Владимир Колпаков
Разработчики Рустам Кулматов,
и Василий Половнёв
Тестировщик Сергей Фролов
Книга набрана шрифтами
«Бюросериф» и «Бюросанс»
Дизайн‑бюро Артёма Горбунова
дом 36, строение 2
Москва, Россия, 127015
Ильяхов Максим Олегович
Информационный стиль
Арт‑директор и издатель Артём Горбунов
Иллюстратор Андрей Кокорин
Дизайнер обложки Владимир Колпаков
Разработчики Рустам Кулматов,
и Василий Половнёв
Тестировщик Сергей Фролов
Книга набрана шрифтами
«Бюросериф» и «Бюросанс»
Дизайн‑бюро Артёма Горбунова
дом 36, строение 2
Москва, Россия, 127015