Существует ли общепринятый способ описать в документации сигнатуру фукции/метода?

#java #c_sharp #cpp #bash #документация

Допустим есть некая функция, которая сама разбирает список аргументов

foo(...){

}


Сначала она ожидает агрумент bar, потом неограниченное число пар baz quux

foo(bar baz1 quux1 baz2 quux2 baz3 quux3)


Есть ли общепринятый способ описать аргументы функции? Что-то на подобие uml, но
в виде текста. Например такое:

# Function foo
# foo( [ ]...)
foo(...){

}

    

Ответы

Ответ 1

Вот ссылки на документацию по оформлению кода.

Конвенция для java Раздел 5.2

Стандарты С++, PDF и ISO 17

C# и XML-стандарт