> For the complete documentation index, see [llms.txt](https://shuras-organization.gitbook.io/csharpunitystyleguide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shuras-organization.gitbook.io/csharpunitystyleguide/kommentarii-v-kode/xml-kommentarii.md).

# XML - комментарии

Без острой необходимости не используются, если только вы не пишете публичный API.

> К примеру, когда вы пишете класс в C# своего внутреннего проекта, то писать там XML-комментарии будет скорее моветоном и показателем не достаточно хорошо прописанного класса.
>
> В то же время если пишется EditorScript или вспомогательный метод с "особым" поведением. То к такому коду XML-комментарии могут быть написаны но лишь в случае острой в них необходимости.
>
> Ну и ситуацией, когда XML-комментарии скорее необходимы, это когда вы пишете публичный API с которым будут работать только на вызов люди, которым не нужно лезть в детали реализации что бы понять, что произойдет.