Руководство по написанию спецификаций в Erlang

Question

В проектах с открытым исходным кодом я вижу следующие два способа написания спецификаций:

Характеристики в комментариях

@spec start_link() -> {ok, pid()}

Спецификации в исходном коде

-spec start_link() -> {ok, pid()}

Какая разница? Один предпочтительнее другого?

Answer 1

Версия комментария (@spec) предшествует версии исходного кода (-spec). Последнее предпочтительнее.

согласно Документация EDoc :

Примечание. Хотя синтаксис, описанный ниже, все еще можно использовать для определения функций мы рекомендуем использовать спецификации Erlang как описанные в Типы и спецификации функций следует добавить к вместо исходного кода. Таким образом, анализы диализатора могут быть используется в процессе обеспечения соответствия документации и до настоящего времени. Erlang спецификации будут использоваться, если нет спецификация функции (тег @spec, за которым следует тип) с тем же имя.