---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://ytsaurus.tech/docs/en/user-guide/storage/annotations.md
  - https://ytsaurus.tech/docs/ru/user-guide/storage/annotations.md
---
> **Documentation Index:** Fetch the complete configuration index at https://ytsaurus.tech/docs/ru/llms.txt

<!-- source: ru/_includes/user-guide/storage/annotations.md -->
# Аннотации 

В данном разделе описываются аннотации таблиц, директорий и других узлов [Кипариса](https://ytsaurus.tech/docs/ru/user-guide/storage/cypress.md).

## Предназначение аннотаций { #rationale }

Аннотации — это способ снабдить таблицу, директорию или любой другой узел Кипариса коротким описанием.

Формально таким описанием может служить произвольный текст длиной до 1 КБ, состоящий из неуправляющих ASCII-символов, однако рекомендуется придерживаться формата Markdown.

{% note info "Примечание" %}

Аннотации хранятся в памяти мастер-серверов YTsaurus. Рекомендуется ограничивать содержимое аннотаций одним-двумя предложениями и ссылками на более подробную документацию.

{% endnote %}

## Атрибут annotation { #annotation_attribute }

У всех узлов Кипариса имеется атрибут `annotation`, значением которого является [YSON string](https://ytsaurus.tech/docs/ru/user-guide/storage/yson.md). Значение можно задать, как и для других атрибутов:

```bash
yt set //home/project/path/table/@annotation '"This table contains valuable data."'
```

Удаление производится обычным образом:

```bash
yt remove //home/project/path/table/@annotation
```

{% note info "Примечание" %}

Атрибут `annotation` присутствует всегда, но по умолчанию равен `null`. Удаление сбрасывает атрибут до значения `null`, однако формально он продолжает существовать.

Таким образом, проверка существования атрибута `annotation` всегда возвращает положительный результат и потому бесполезна. Вместо этого следует проверять атрибут на равенство `null`.

Такая особенность поведения связана с наследованием.

{% endnote %}

## Наследование { #inheritance }

Аннотация может сопровождать как таблицу, так и целое поддерево. Чтобы добавить аннотацию поддерева, установите ее на соответствующую директорию. После этого любой узел, рекурсивно содержащийся в ней и не обладающий собственной аннотацией, отобразит ее в своем атрибуте `annotation`.

Иными словами, атрибут `annotation` наследуется: в нем всегда отображается ближайшая ненулевая аннотация предка. Поиск начинается с самого узла.

Чтобы понять, какому предку принадлежит отображаемая аннотация, существует атрибут `annotation_path`. Он доступен только для чтения и содержит полный путь к соответствующему предку или к самому узлу, если аннотирован непосредственно он.

## Поддержка в веб-интерфейсе { #web_interface }

Веб-интерфейс поддерживает отображение аннотаций и воспринимает формат Markdown — диалект [YFM](https://ydocs.tech/en/), который поддерживается пакетом [@doc-tools/transform](https://www.npmjs.com/package/@doc-tools/transform).
Аннотации отображаются в разделе **Navigation**, на вкладке **Annotation** выбранного узла. Чтобы отредактировать аннотацию, нажмите **Edit metadata** и перейдите на вкладку **Description**.
<!-- endsource: ru/_includes/user-guide/storage/annotations.md -->