A function’s doc comment should explain what the function returns or, for functions called for side effects, what it does. Named parameters and results can be referred to directly in the comment, without any special syntax like backquotes. (A consequence of this convention is that names like a, which might be mistaken for ordinary words, are typically avoided.) For example:
Комментарий к документации функции должен объяснять, что возвращает функция, или, для функций, вызываемых для побочных эффектов, что она делает. На именованные параметры и результаты можно ссылаться непосредственно в комментарии, без какого-либо специального синтаксиса, например обратных кавычек. (Следствием этого соглашения является то, что обычно избегаются такие имена, как a, которые можно принять за обычные слова.) Например: