Отступ (набор текста)
В письменной форме многих языков : отступы описывают пустое пространство, также известное как пробел , который используется вокруг текста для обозначения важного аспекта текста, например
Многие компьютерные языки используют блочные отступы для разграничения блоков исходного кода .
Отступ по существу один и тот же, независимо от того, используется ли система письма слева направо (например, латынь и кириллица ) или справа налево (например, иврит и арабский язык ) при рассмотрении начала и конца строки. Например, отступ в начале строки означает наличие слева для сценария с письмом слева направо и справа для сценария с письмом справа налево.
Отступ – это и существительное, и глагол. Глагол — это действие по форматированию текста, в котором будет сделан отступ, тогда как существительное относится к образующемуся пустому пространству.
Типы
[ редактировать ]Существует три основных типа отступов: первая строка, висячий и блочный.
Каждый приведенный ниже пример находится в поле, обозначающем границу страницы и использующем стандартное содержимое lorem ipsum . Ширина отступа здесь выражается в единицах em .
- При отступе первой строки отступ делается к первой строке абзаца.
- Отступ первой строки в 2 em: Важно заботиться о больном, чтобы за ним следили, но это произойдет в такое время, когда будет много работы и боли. Если говорить до мельчайших подробностей, то никто не должен заниматься никакой работой, если не получит от нее какой-либо пользы. Не сердись на боль, на выговор, на удовольствие он хочет быть волоском от боли в надежде, что не будет размножения. Если они не ослеплены похотью, они не выступают вперед; виноваты те, кто оставляет свои обязанности и смягчает свои сердца, то есть свои труды;
- При висячем отступе отступы делаются все, кроме первой строки абзаца.
- Висячий отступ в 2 ем: Важно заботиться о больном, чтобы за ним следили, но это произойдет в такое время, когда будет много работы и боли. Если говорить до мельчайших подробностей, то никто не должен заниматься никакой работой, если не получит от нее какой-либо пользы. Не сердись на боль, на выговор, на удовольствие он хочет быть волоском от боли в надежде, что не будет размножения. Если они не ослеплены похотью, они не выступают вперед; виноваты те, кто оставляет свои обязанности и смягчает свои сердца, то есть свои труды;
- При блочном отступе весь абзац имеет отступ относительно предыдущего абзаца.
- Отступ блока в 2 em слева: Важно заботиться о больном, чтобы за ним следили, но это произойдет в такое время, когда будет много работы и боли. Если говорить до мельчайших подробностей, то никто не должен заниматься никакой работой, если не получит от нее какой-либо пользы. Не сердись на боль, на выговор, на удовольствие он хочет быть волоском от боли в надежде, что не будет размножения. Если они не ослеплены похотью, они не выступают вперед; виноваты те, кто оставляет свои обязанности и смягчает свои сердца, то есть свои труды;
- Блочный отступ с обеих сторон обычно используется для цитаты . Блочная цитата здесь показана с помощью 2 em слева и справа, но поскольку она не выравнивается по правому краю , пустое пространство справа варьируется в зависимости от длины строки: Важно заботиться о больном, чтобы за ним следили, но это произойдет в такое время, когда будет много работы и боли. Если говорить до мельчайших подробностей, то никто не должен заниматься никакой работой, если не получит от нее какой-либо пользы. Не сердись на боль, на выговор, на удовольствие он хочет быть волоском от боли в надежде, что не будет размножения. Если они не ослеплены похотью, они не выступают вперед; виноваты те, кто оставляет свои обязанности и смягчает свои сердца, то есть свои труды;
- Здесь то же самое, что и предыдущее, но с выравниванием по левому и правому краю: Важно заботиться о больном, чтобы за ним следили, но это произойдет в такое время, когда будет много работы и боли. Если говорить до мельчайших подробностей, то никто не должен заниматься никакой работой, если не получит от нее какой-либо пользы. Не сердись на боль, на выговор, на удовольствие он хочет быть волоском от боли в надежде, что не будет размножения. Если они не ослеплены похотью, они не выступают вперед; виноваты те, кто оставляет свои обязанности и смягчает свои сердца, то есть свои труды;
Отступы в программировании
[ редактировать ]В компьютерном программировании отступ описывает форматирование исходного кода с пробелами слева от текста кода — часто для того, чтобы визуально показать, что последовательность строк кода синтаксически является блоком кода . Обычно строки блока выравниваются по пробелам, указывающим глубину блока в иерархической структуре кода. Каждый внутренний уровень иерархии имеет отступ, кратный этой ширине отступа .
Пробелы в коде обычно сохраняются как символы пробелов .
Для языка свободной формы отступы предназначены исключительно для программиста, поскольку процессор кода (т. е. компилятор , интерпретатор ) игнорирует пробельные символы. Код может иметь непоследовательные отступы или даже отсутствовать, но в целом он отформатирован с достаточно последовательными отступами.
Некоторые языки полагаются на отступы для разграничения структуры блоков, часто с помощью правила офсайда . Из-за этого синтаксического требования код должен иметь уровень согласованности, который не требуется в коде языка свободной формы.
Неологизмы . outdent , unindent и dedent описывают противоположность отступа – выравнивание текста кода строки слева от предыдущей строки
Вариации
[ редактировать ]Общие варианты реализации отступов включают в себя: насколько отступать блок на каждом уровне иерархии кода, обычно измеряется в пробелах, и следует ли хранить пробельные символы как символы пробела или табуляции .Хотя существуют общие практики, консенсус не является универсальным. [1] Эти различия обусловлены факторами, которые могут включать, помимо прочего: синтаксис языка, полномочия организации и личные предпочтения.
Общие практики
[ редактировать ]В следующей таблице представлены известные практики в отношении отступов кода.
| Язык | Свободная форма? | Примечание |
|---|---|---|
| Баш | Да | Руководство по стилю Фрица Менера предлагает 2, 4 или 8 пробелов и использует 2 во всех примерах. [2] |
| С | Да | Ядро Linux использует 1 вкладку [4] [5] Клинтон Стейли выступает за 3 места [7] |
| С++ | Да | WebKit рекомендует 4 пробела. [8] Google использует 2 пробела [9] |
| С# | Да | Соглашение Microsoft : 4 пробела [10] |
| CSS | Да | Drupal , GitHub и Google используют два пробела. [11] [12] [13] [14] |
| Дарт | Да | dart format использует 2 пробела |
| Дельфи | Да | Руководство по стилю Delphi: 2 пробела [16] |
| Ф# | Да | Руководство по стилю F#: 4 пробела [17] |
| Идти | Да | Эффективное го : 1 таб. [18] |
| Хаскелл | Нет | Google использует 2 пробела [19] |
| HTML | Да | Google использует 2 пробела [13] |
| Ява | Да | Oracle использует 4 пробела [21] Android использует 4 пробела [22] Большинство компонентов Eclipse IDE используют вкладки. |
| JavaScript | Да | Дуглас Крокфорд выступает за 4 пространства [23] GitHub и Google используют два места. [24] [25] jQuery использует вкладки [26] Firefox Встроенный jsbeautifier по умолчанию использует 2 пробела. Prettyprinter в Google Chrome и Internet Explorer использует 4 пробела |
| Юлия | Да | Гид по стилю Джулии: 4 места [27] |
| Котлин | Да | Руководство по стилю Kotlin: 4 пробела [28] |
| Два | Да | Руководство по стилю Lua: 2 пробела [29] |
| Перл | Да | Ларри Уолл предпочитает 4 места [30] |
| PHP | Да | Drupal использует 2 пробела [31] PEAR и Zend используют 4 пробела. [32] [33] CodeIgniter и WordPress используют вкладки [34] [35] PSR-2 определяет 4 пробела [36] |
| PowerShell | Да | Неофициальное руководство по лучшим практикам и стилю PowerShell: 4 пробела [37] |
| Питон | Нет | PEP 8: 4 места [38] |
| Руби | Да | Руководство по стилю Ruby: 2 пробела [39] |
| Ржавчина | Да | Руководство по стилю Rust: 4 пробела [40] |
| Скала | Да | Руководство по стилю Scala: 2 пробела [41] |
| Быстрый | Да | Google использует 2 пробела [42] |
| Ткл | Да | Руководство по стилю Tcl: 4 пробела [43] |
| Визуальный Бейсик | Да | Соглашение Microsoft: 4 пробела [44] |
| XML | Да | Google использует 2 пробела [45] |
Эластичные табуляции
[ редактировать ]В 2006 году был предложен новый метод отступов, получивший название « эластичные табуляции» . [ нужна ссылка ]
Ссылки
[ редактировать ]- ^ «Табы против пробелов: вечная священная война» . Jwz.org . 5 января 2007 года . Проверено 18 января 2014 г.
- ^ «Руководство по стилю Bash и стандарт кодирования» (PDF) . Lug.fh-swf.de .
- ^ «Архивная копия» . Архивировано из оригинала 26 июня 2014 года . Проверено 23 июня 2014 г.
{{cite web}}: CS1 maint: архивная копия в заголовке ( ссылка ) - ^ «Архивная копия» . Архивировано из оригинала 14 февраля 2015 года . Проверено 15 февраля 2015 г.
{{cite web}}: CS1 maint: архивная копия в заголовке ( ссылка ) - ^ «Стиль кодирования ядра Linux» . Архивировано из оригинала 11 июня 2022 года . Проверено 21 июля 2022 г.
- ^ «ГИД СТИЛЯ С» . Сервер технических отчетов НАСА . Август 1994 года.
- ^ Стейли, Клинтон (2006). «Правила стиля программы на языке C» . Кафедра компьютерных наук и разработки программного обеспечения Калифорнийского политехнического университета .
- ^ «Рекомендации по стилю кода» . Вебкит . 7 ноября 2015 года . Проверено 31 декабря 2021 г.
- ^ [1] Архивировано 6 октября 2014 г. в Wayback Machine.
- ^ Билл Вагнер. «Соглашения по кодированию на C# (Руководство по программированию на C#)» . Msdn.microsoft.com . Проверено 3 сентября 2017 г.
- ^ «Руководство по форматированию CSS» . Друпал.орг . 14 января 2013 года . Проверено 18 января 2014 г.
- ^ «CSS · Руководство по стилю · GitHub» . Гитхаб.com . Проверено 18 января 2014 г.
- ^ Jump up to: а б «Руководство по стилю Google HTML/CSS» . Гугл ГитХаб . Отступ. Архивировано из оригинала 13 марта 2016 года . Проверено 13 марта 2016 г.
Отступ на 2 пробела за раз.
Это копия официальной версии в формате HTML, которая поддерживается в формате XML. - ^ «Руководство по стилю: Руководства по стилю для проектов с открытым исходным кодом, созданных Google» . Гитхаб.com . 3 сентября 2017 г. Проверено 3 сентября 2017 г.
- ^ «WordPress › Стандарты кодирования CSS «Создание ядра WordPress» . Make.wordpress.org . 17 июля 2012 года . Проверено 20 июля 2018 г.
- ^ «Руководство по стилю Delphi's Object Pascal — Использование пробелов» . Проверено 13 декабря 2022 г.
- ^ «Рекомендации по форматированию кода F#» . docs.microsoft.com . Проверено 14 октября 2020 г.
- ^ «Эффективный Go — язык программирования Go» . golang.org . Проверено 3 сентября 2017 г.
- ^ «HaskellStyleGuide – ganeti – Руководство по стилю для кода Haskell – Программное обеспечение для управления виртуализацией на основе кластеров – Хостинг проектов Google» . Code.google.com . 8 января 2014 года. Архивировано из оригинала 27 июня 2013 года . Проверено 18 января 2014 г.
- ^ «Краткий справочник по параметрам конфигурации HTML Tidy» . Tidy.sourceforge.net . 18 июня 2008 года . Проверено 18 января 2014 г.
- ^ «Соглашения по коду для языка программирования Java: 4. Отступы» . Oracle.com . Проверено 18 января 2014 г.
- ^ «Рекомендации по стилю кода для участников | Разработчики Android» . Источник.android.com . Проверено 18 января 2014 г.
- ^ «Соглашения по коду для языка программирования JavaScript» . Javascript.crockford.com . 13 ноября 2006 г. Проверено 18 января 2014 г.
- ^ «Руководство по стилю JavaScript 路» . Гитхаб.com . Архивировано из оригинала 15 августа 2013 года . Проверено 18 января 2014 г.
- ^ «Правила стиля JavaScript» . Google-styleguide.googlecode.com . Архивировано из оригинала 16 февраля 2014 года . Проверено 18 февраля 2014 г.
- ^ Фонд jQuery — jquery.org. «Руководство по стилю JavaScript | Внесение вклада в jQuery» . Contribute.jquery.org . Проверено 18 января 2014 г.
- ^ «Руководство по стилю · Язык Джулии» . docs.julialang.org .
- ^ «Соглашения о кодировании — язык программирования Kotlin» . Котлин .
- ^ «lua-users wiki: Руководство по стилю Lua» . lua-users.org . Проверено 3 сентября 2017 г.
- ^ Аллен, Джон (Джей-Джей) (ред.). «perlstyle: Руководство по стилю Perl» . Документация по Perl 5 версии 32.1 . Фонд Перла . Проверено 19 апреля 2021 г.
- ^ «Стандарты кодирования» . Друпал.орг . Проверено 18 января 2014 г.
- ^ «Руководство :: Отступы и длина строк» . Груша.php.net . Проверено 18 января 2014 г.
- ^ «Стандарт кодирования PHP (проект) – Авторы – Zend Framework Wiki» . Framework.zend.com . Архивировано из оригинала 3 января 2008 года . Проверено 18 января 2014 г.
- ^ «Руководство по стилю: Руководство пользователя CodeIgniter» . Ellislab.com . Проверено 18 января 2014 г.
- ^ «WordPress › Стандарты кодирования PHP «Создание ядра WordPress» . Make.wordpress.org . 23 июля 2012 года . Проверено 18 января 2014 г.
- ^ «PHP: Руководство по стилю кодирования» . Php-fig.org . Архивировано из оригинала 15 марта 2014 года . Проверено 18 февраля 2014 г.
- ^ «Разметка и форматирование кода – практика и стиль PowerShell» . Практика и стиль PowerShell . Проверено 17 октября 2021 г.
- ^ «PEP 8 – Руководство по стилю для кода Python» . Python.org . Проверено 3 сентября 2017 г.
- ^ Бацов, Божидар (3 сентября 2017 г.). «ruby-style-guide: руководство по стилю кодирования Ruby, созданное сообществом» . Гитхаб.com . Проверено 3 сентября 2017 г.
- ^ «ржавчина: безопасный, одновременный и практичный язык» . Гитхаб.com . 3 сентября 2017 г. Проверено 3 сентября 2017 г.
- ^ «Отступы — Документация Scala» . docs.scala-lang.org . Проверено 3 сентября 2017 г.
- ^ «Руководство по быстрому стилю» . google.github.io . Проверено 17 октября 2021 г.
- ^ Рэй Джонсон. «Руководство по стилю Tcl» (PDF) . Tcl.tk. Проверено 3 сентября 2017 г.
- ^ «Соглашения о структурированном кодировании» . msdn.microsoft.com . 4 января 2007 года . Проверено 3 сентября 2017 г.
- ^ «Руководство по стилю формата формата XML-документа Google» . google.github.io . Google . Проверено 17 октября 2021 г.
