Skip to content

Commit

Permalink
Merge pull request true-grue#30 from Shindze/main
Browse files Browse the repository at this point in the history
Внесение корректировок в оформление текста
  • Loading branch information
true-grue authored Dec 15, 2021
2 parents 92f59c9 + f43d653 commit 4c78c3e
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
10 changes: 5 additions & 5 deletions md/command_line.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Командная строка, как ни странно, хорошо знакома и любителям старых текстовых игр. В этих играх для совершения какого-либо действия необходимо набрать с клавиатуры соответствующую команду в духе `go north`, `read book` или `take apple`.

Вот как выглядит пример диалога с пользователем в игре Zork (1979 г.):
Вот как выглядит пример диалога с пользователем в игре Zork (1978 г.):

```default
West of House Score: 0 Moves: 4
Expand Down Expand Up @@ -116,7 +116,7 @@ total 4

* `pwd` (print working directory). Вывести имя текущего каталога.
* `ls` (list). Вывести содержимое каталога.
* `echo`. Вывести свой аргумент.
* `echo` Вывести свой аргумент.
* `cat` (concatenate). Вывести содержимое файла.
* `mkdir` (make directory). Создать каталог.
* `cp` (copy). Скопировать файл.
Expand Down Expand Up @@ -312,7 +312,7 @@ drwxr-xr-x 2 root root 37 Nov 4 18:01 foo

Первый столбец определяет права доступа и информацию о файле (`-`) или каталоге (`d`, как в случае с foo), закодированную в первом символе. Флаги доступа бывают следующих основных видов:

* `-`. Доступ запрещен.
* `-` Доступ запрещен.
* `r` (read). Имеется доступ на чтение.
* `w` (write). Имеется доступ на запись.
* `x` (execute). Имеется доступ на исполнение (на вход в случае каталога).
Expand Down Expand Up @@ -411,7 +411,7 @@ localhost:~# seq 5 | xargs
1 2 3 4 5
```

Команда `tr`(translate) осуществляет замену текстовых фрагментов:
Команда `tr` (translate) осуществляет замену текстовых фрагментов:

```default
localhost:~# seq 5 | xargs | tr " " "*"
Expand Down Expand Up @@ -548,4 +548,4 @@ root@Server584432:~# ./hn.sh
|| ||
```

На тему анализа данных в командной строке существует целая книга @janssens2021data.
На тему анализа данных в командной строке существует целая книга @janssens2021data.
22 changes: 11 additions & 11 deletions md/docs_as_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@

В связи с вышесказанным перспективным является подход «документация как код» (docs as code), основная идея которого в использовании для создания технической документации тех же процессов, что и для разработки программ. Подход «документация как код» отличается следующими особенностями:

* Использование текстовых языков разметки, удобных как для чтения человеком, так и с точки зрения машинной обработки.
* Использование текстовых языков описания графических материалов.
* Использование системы контроля версий для хранения проекта документации.
* Использование инструментов командной строки для автоматической проверки, сборки документации и непрерывной интеграции (continuous integration).
* Использование текстовых языков разметки, удобных как для чтения человеком, так и с точки зрения машинной обработки;
* Использование текстовых языков описания графических материалов;
* Использование системы контроля версий для хранения проекта документации;
* Использование инструментов командной строки для автоматической проверки, сборки документации и непрерывной интеграции (continuous integration);
* Ориентация на выходной web-формат.

## Языки разметки

Языки разметки, помимо очевидной возможности написания текстов, поддерживают специальные команды, отвечающие за внешний вид и структурные особенности документа. В отличие от обычных WYSIWYG-редакторов («что вижу на экране, то и получу в документе») язык разметки позволяет документ «запрограммировать», при этом «программа» на языке разметки и ее результат в виде документа отличаются друг от друга.
Языки разметки, помимо очевидной возможности написания текстов, поддерживают специальные команды, отвечающие за внешний вид и структурные особенности документа. В отличие от обычных WYSIWYG-редакторов («что вижу на экране, то и получу в документе»), язык разметки позволяет документ «запрограммировать», при этом «программа» на языке разметки и ее результат в виде документа отличаются друг от друга.

Очевидным примером языка разметки является HTML, но для задач составления документации было создано множество специальных языков, в частности:

* LaTeX,
* Markdown,
* reStructuredText,
* LaTeX;
* Markdown;
* reStructuredText;
* AsciiDoc.

Важным достоинством языка разметки является удобство использование системы контроля версий – в истории репозитория легко отследить изменения, внесенные в документ. Этого не удалось бы добиться с двоичными форматами в духе docx.
Expand Down Expand Up @@ -185,7 +185,7 @@ digraph G {

![Результат работы Graphviz](docs6.svg){#fig:docs6}

Еще одним популярным инструментом является PlantUML, предназначенный для создания как UML-диаграмм различного вида, таки для диаграмм иного вида (диаграммы Ганта, интеллект-карты и проч.).
Еще одним популярным инструментом является PlantUML, предназначенный для создания как UML-диаграмм различного вида, так и для диаграмм иного вида (диаграммы Ганта, интеллект-карты и проч.).

Ниже представлен пример диаграммы, описанной на языке PlantUML:

Expand Down Expand Up @@ -219,8 +219,8 @@ deactivate B

Примеры генераторов документации:

* Javadoc для языка Java.
* Doxygen для C++ и некоторых других языков.
* Javadoc для языка Java;
* Doxygen для C++ и некоторых других языков;
* Расширения для системы Sphinx, поддерживающие целый ряд языков.

Ниже показан пример программы на языке C со специальными комментариями, поддерживаемыми системой Doxygen. Обратите внимание на специальные ключевые слова `\file`, `\brief` и `\param`:
Expand Down
2 changes: 1 addition & 1 deletion md/virtual_machines.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

Рассмотрим классический пример П-кода (P-code) для виртуального выполнения программ на языка Паскаль, предложенный в середине 70-х годов. Специальный вариант компилятора Паскаля порождает платформонезависимый П-код. Для различных программно-аппаратных платформ реализованы интерпретаторы П-кода, также включающие библиотеку времени выполнения. В результате компилятор существует только в одном варианте и для каждой из новых целевых платформ достаточно реализовать небольшую программу – интерпретатор П-кода.

К ярким историческим примерам успешного портирования компьютерных игр на множество различных игровых платформ относятся текстовая игра Zork (1979), реализованная в коде виртуальной Z-машины, а также игра Another World (1991), имеющая изощренную виртуальную машину с поддержкой многопоточности, графики и звука.
К ярким историческим примерам успешного портирования компьютерных игр на множество различных игровых платформ относятся текстовая игра Zork (1978), реализованная в коде виртуальной Z-машины в 1979 году, а также игра Another World (1991), имеющая изощренную виртуальную машину с поддержкой многопоточности, графики и звука.

К популярным современным языковым виртуальным машинам можно отнести:

Expand Down

0 comments on commit 4c78c3e

Please sign in to comment.