Skip to content

Дописывает доку о DataView#5888

Open
marss-hub wants to merge 26 commits intodoka-guide:mainfrom
marss-hub:add-info-about-dataview
Open

Дописывает доку о DataView#5888
marss-hub wants to merge 26 commits intodoka-guide:mainfrom
marss-hub:add-info-about-dataview

Conversation

@marss-hub
Copy link
Copy Markdown

@marss-hub marss-hub commented Sep 11, 2025

Описание

Дополняю статью о DataView

Превью: https://content-5888.dev.doka.guide/js/data-view/

Closes #4793

Чек-лист

  • Текст оформлен согласно руководству по стилю
  • Ссылки на внутренние материалы начинаются со слеша и заканчиваются слэшем либо якорем на заголовок (/css/color/, /tools/json/, /tools/gulp/#kak-ponyat)
  • Ссылки на картинки, видео и демки относительные (images/example.png, demos/example/, ../demos/example/)

@github-actions github-actions bot added js Контент по JavaScript дока Справочный материал placeholder Заготовка материала labels Sep 11, 2025
@vitya-ne vitya-ne removed the placeholder Заготовка материала label Sep 11, 2025
@vitya-ne
Copy link
Copy Markdown
Contributor

@marss-hub Привет!
Спасибо за подробную доку на такую непростую тему.
Я добавил пару коментов, посмотри пожалуйста

@marss-hub
Copy link
Copy Markdown
Author

@marss-hub Привет! Спасибо за подробную доку на такую непростую тему. Я добавил пару коментов, посмотри пожалуйста

@vitya-ne Привет! Спасибо за комментарии, добавила по ним в доку еще немного информации

Copy link
Copy Markdown
Member

@Inventoris Inventoris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Светлана привет! Витя и Матвей посмотрели пиар, а значит самое время набежать и мне)

Смотри, это большая работа, и ты взяла очень сложную тему (что крайне круто). Поэтому сразу предупрежу: зафиналить такой текст нелегко. Но я постараюсь с этим помочь =)

У нас есть вот такое руководство по стилю. Очень прошу тебя посмотреть на три главных момента в тексте:

  1. Очень сложно. Дока это тексты, которые можно начать с "Короче, эта штука делает...". Сейчас текст больше похож на серьезную документацию, Дока старается от этого уйти.
  2. Посмотри пожалуйста на блок документации "текст утяжеляют". Нужно убрать все такие вещи, в первую очередь диепричастия, вроде "задавая" итд.
  3. Есть орфографические ошибки, посмотри на текст ещё разок. Местами потерялись запятые.

Если тебе тяжело это сделать, нет времени или желания, можно попросить ChatGPT отредактировать текст, скормив ему в качестве примера одну из док Алёны, например.

Ах да, уверен блок "Как понять" тут не помешает, давай его тоже добавим, чтобы была структура доки.

@marss-hub
Copy link
Copy Markdown
Author

Светлана привет! Витя и Матвей посмотрели пиар, а значит самое время набежать и мне)

Смотри, это большая работа, и ты взяла очень сложную тему (что крайне круто). Поэтому сразу предупрежу: зафиналить такой текст нелегко. Но я постараюсь с этим помочь =)

У нас есть вот такое руководство по стилю. Очень прошу тебя посмотреть на три главных момента в тексте:

  1. Очень сложно. Дока это тексты, которые можно начать с "Короче, эта штука делает...". Сейчас текст больше похож на серьезную документацию, Дока старается от этого уйти.
  2. Посмотри пожалуйста на блок документации "текст утяжеляют". Нужно убрать все такие вещи, в первую очередь диепричастия, вроде "задавая" итд.
  3. Есть орфографические ошибки, посмотри на текст ещё разок. Местами потерялись запятые.

Если тебе тяжело это сделать, нет времени или желания, можно попросить ChatGPT отредактировать текст, скормив ему в качестве примера одну из док Алёны, например.

Ах да, уверен блок "Как понять" тут не помешает, давай его тоже добавим, чтобы была структура доки.

Привет Алексей!

Спасибо за четкую формулировку необходимых доработок для финализации.

Я доработала текст:

  1. Внесла стилистические изменения чтобы сделать его легче и дружелюбнее
  2. Добавила структуру заголовков
  3. Проверила дополнительно на ошибки и опечатки

Надеюсь, он стал лучше ;)

@marss-hub marss-hub requested a review from Inventoris October 29, 2025 15:32
@marss-hub
Copy link
Copy Markdown
Author

Внесла правки в стиль и структуру доки

@marss-hub marss-hub closed this Oct 29, 2025
@marss-hub marss-hub requested a review from Inventoris November 4, 2025 19:48
@marss-hub
Copy link
Copy Markdown
Author

Хорошо получается! Оставил комментов, загляни пж:

Внесла правки, по комментам отписалась. Жду нового ревью, глянь пожалуйста.

Copy link
Copy Markdown
Member

@Inventoris Inventoris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Отлично ƪ(˘⌣˘)ʃ

Оставил один коммент снизу, а так апрув)

P.S. Возможно, кто-то из нашей команды может набежать с правками, будь готова. Но может и не набежать, думаю, основное уже ок.

Copy link
Copy Markdown
Member

@HellSquirrel HellSquirrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Замечательная дока! Спасибо большое за PR. Я добавила несколько предложений и коментов

@marss-hub
Copy link
Copy Markdown
Author

marss-hub commented Nov 15, 2025

@Inventoris без тебя тут не обойтись 🆘
Пожалуйста, можешь тоже взглянуть на предложенные правки?
(и те, на которые я оставила комменты и остальные)

Мы с тобой существенно упростили первоначально предложенный мной вариант статьи, и мне не хотелось бы возвращаться к усложнению и добавлению информации, которая снова может оказаться избыточной. И, как следствие, не очень ясно, в каких моментах указанных в правках, стоит расширять статью (и углубляться), а в каких она достаточна..

@marss-hub
Copy link
Copy Markdown
Author

@Inventoris маякни пожалуйста - мне лучше дождаться твоих комментов или начинать править на своё усмотрение?

@vitya-ne
Copy link
Copy Markdown
Contributor

vitya-ne commented Dec 25, 2025

@marss-hub
Мне кажется, подразделы Указание порядка байтов и Выход за границы буфера стоит переместить из Как пишется в Как понять.
Если я упустил обсуждение этого вопроса, поправь меня

@marss-hub
Copy link
Copy Markdown
Author

@marss-hub Мне кажется, подразделы Указание порядка байтов и Выход за границы буфера стоит переместить из Как пишется в Как понять. Если я упустил обсуждение этого вопроса, поправь меня

вот здесь мы что-то с переносом делали уже.
Если так будет правильнее - могу перенести из Как пишется в Как понять перечисленные подразделы

@vitya-ne
Copy link
Copy Markdown
Contributor

вот здесь мы что-то с переносом делали уже.

Хмм.. Конечно немного странно, если блоки приходиться двигать дважды...
Посмотрел ещё раз.

  • Указание порядка байтов можно отнести к синтаксису (Как пишется), потому что там описывается параметр определяющий endianness.
  • Выход за границы буфера - объясняет поведение и как по мне логичнее смотрелся бы в Как понять.
    А ты как считаешь ?

@marss-hub
Copy link
Copy Markdown
Author

вот здесь мы что-то с переносом делали уже.

Хмм.. Конечно немного странно, если блоки приходиться двигать дважды... Посмотрел ещё раз.

  • Указание порядка байтов можно отнести к синтаксису (Как пишется), потому что там описывается параметр определяющий endianness.
  • Выход за границы буфера - объясняет поведение и как по мне логичнее смотрелся бы в Как понять.
    А ты как считаешь ?

Я согласна что Выход за границы буфера - раздел точно не про синтаксис, и поэтому мне кажется логичнее его "вынуть" из Как пишется и перенести или в Подсказки или в Как понять. А вот куда перенести лучше - тут нужен совет.

@vitya-ne
Copy link
Copy Markdown
Contributor

Я согласна что Выход за границы буфера - раздел точно не про синтаксис, и поэтому мне кажется логичнее его "вынуть" из Как пишется и перенести или в Подсказки или в Как понять. А вот куда перенести лучше - тут нужен совет.

Я за перенос в 'Как понять'.

@marss-hub
Copy link
Copy Markdown
Author

Я согласна что Выход за границы буфера - раздел точно не про синтаксис, и поэтому мне кажется логичнее его "вынуть" из Как пишется и перенести или в Подсказки или в Как понять. А вот куда перенести лучше - тут нужен совет.

Я за перенос в 'Как понять'.

Отлично! Перенесла

@github-actions
Copy link
Copy Markdown

Превью контента из a8c9a48 опубликовано.

@marss-hub
Copy link
Copy Markdown
Author

Всем привет! Хотела узнать как дела с аппрувом доки, а то как застопорилось всё..
@HellSquirrel есть минутка посмотреть, чтобы процесс продолжился?

Copy link
Copy Markdown
Member

@HellSquirrel HellSquirrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Очень круто! Давай немножко улучшим часть про порядок и адресацию

const buffer = new Uint8Array([0, 42, 0, 42]).buffer
const dataView = new DataView(buffer)

// Читаем 8-битное число с позиции 0
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Давай уточним что мы читаем Uint8 - это беззнаковое число. Разница важна для отричательных чисел (здесь и далее)


### Указание порядка байтов

_Порядок байтов (endianness)_ — это последовательность байтов которая используется для хранения чисел в памяти. По умолчанию `DataView` использует порядок от старшего к младшему (_big-endian_). Подробнее о памяти можно узнать из статьи «[Как устроена память](/tools/trivial-memory-model/)».
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Давай попробуем уточнить тут определение - это не последовательность которая используется для хранения. Хранится все одно и тоже. Это то как это последователльность интерпретируется (адресуется). [0x01, 0x02] - 0x0102 = 258 vs 0x0201 = 513

https://en.wikipedia.org/wiki/Endianness


_Порядок байтов (endianness)_ — это последовательность байтов которая используется для хранения чисел в памяти. По умолчанию `DataView` использует порядок от старшего к младшему (_big-endian_). Подробнее о памяти можно узнать из статьи «[Как устроена память](/tools/trivial-memory-model/)».

`DataView` позволяет явно указать порядок байтов т. к. принимает флаг little-endian при чтении или записи. В обычных типизированных массивах такой возможности нет. Это особенно важно, когда порядок байтов в данных отличается от порядка, используемого в операционной системе.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Тут тоже не совсем понятно. Но я предположу что имеется ввиду - мы читаем какой-то внешний источник и он предпологает один тип адресации и этот тип отличается от адресации в os

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

js Контент по JavaScript дока Справочный материал

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Расширяем материалы о коллекциях в JavaScript: DataView

5 participants