# Как документировать макросы?

Чтобы документировать макросы, используйте [файл свойств](https://docs.getdbt.tech/reference/macro-properties.md) и размещайте настройки внутри ключа `macros:`

## Пример

macros/properties.yml

```yml
macros:
  - name: cents_to_dollars
    description: Макрос для преобразования центов в доллары
    arguments:
      - name: column_name
        type: column
        description: Имя столбца, который вы хотите преобразовать
      - name: precision
        type: integer
        description: Количество десятичных знаков. По умолчанию 2.
```

подсказка

Начиная с dbt v1.10, вы можете включить проверку аргументов, определённых в документации макросов, с помощью флага изменения поведения `validate_macro_args`. При включении этого флага dbt будет:

* Определять аргументы на основе определения макроса и включать их в файл [manifest.json](https://docs.getdbt.tech/reference/artifacts/manifest-json.md), если аргументы не задокументированы.
* Выдавать предупреждение, если имена аргументов в документации не совпадают с определением макроса.
* Выдавать предупреждение, если поля `type` не соответствуют [поддерживаемым форматам](https://docs.getdbt.tech/reference/resource-properties/arguments.md#supported-types).

Узнайте больше о [валидации аргументов макросов](https://docs.getdbt.tech/reference/global-configs/behavior-flags/validate_macro_args.md).

## Документирование пользовательской материализации

Когда вы создаёте [пользовательскую материализацию](https://docs.getdbt.tech/guides/create-new-materializations.md), dbt создаёт связанную с ней макрос с форматом, показанным ниже:

```text
materialization_{materialization_name}_{adapter}
```

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

macros/properties.yml

```yaml
macros:
  - name: materialization_my_materialization_name_default
    description: Пользовательская материализация для вставки записей в таблицу только для добавления и отслеживания времени их добавления.
  - name: materialization_my_materialization_name_xyz
    description: Пользовательская материализация для вставки записей в таблицу только для добавления и отслеживания времени их добавления.
```
