Hướng dẫn viết thông số kỹ thuật trong Erlang

Question

Trong các dự án mã nguồn mở tôi thấy hai cách sau đây viết thông số kỹ thuật:

Specs trong ý kiến ​​

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

Specs trong mã nguồn

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

gì là Sự khác biệt? Là một trong những ưu tiên hơn khác?

Answer 1

Nhận xét (@spec) phiên bản trước phiên bản mã nguồn (-spec). Sau này là thích hợp hơn.

theo EDoc documentation:

Lưu ý: Mặc dù cú pháp được mô tả trong những điều sau vẫn có thể được sử dụng để xác định chức năng chúng tôi khuyên Erlang thông số kỹ thuật như được mô tả trong Types and Function Specification nên được bổ sung vào mã nguồn thay vì . Bằng cách này, các phân tích của Dialyzer có thể là được sử dụng trong quá trình giữ tài liệu phù hợp và được cập nhật. Thông số kỹ thuật Erlang sẽ được sử dụng trừ khi cũng có thông số chức năng (thẻ @spec theo sau là loại) có cùng tên .