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