sân và liên kết đến các lớp/mô-đun trong tài liệu

Question

Tôi hiện đang chuyển từ rdoc sang yard cho tài liệu phần mềm ruby ​​của tôi.

Trong doc của tôi, tôi thường tham khảo một số lớp học/modules từ các ý kiến, ví dụ:

## == Provides various utility features 
## 
## == Features 
## 
## Logging : logging is provided by the Mysoft::Mypackage::Utility::Logger class 
## 

rdoc một cách chính xác tạo ra một liên kết đến Mysoft :: mypackage :: Tiện ích :: trang tài liệu lớp Logger, trong khi yard bỏ qua thẻ và xem tên lớp là chuỗi đơn giản.

Tôi biết rằng sân có thẻ @see, tuy nhiên điều này sẽ tạo một phần "Xem thêm" riêng trong tài liệu, trong khi tôi cần tham chiếu lớp/mô-đun với bên trong văn bản mô tả của mình.

Tôi chắc chắn thiếu điều gì đó, nhưng nếu bạn có bất kỳ ví dụ nào về cách thực hiện việc này với sân, tôi thực sự đánh giá cao.

Cảm ơn mỗi advace,

dl

Answer 1

Quoth the documentation:

YARD hỗ trợ cú pháp đặc biệt để liên kết với các đối tượng mã khác hoặc các tập tin. Cú pháp là {ObjectName#method OPTIONAL_TITLE}. Cú pháp này có thể chấp nhận được ở bất kỳ đâu trong tài liệu ngoại trừ thẻ @see, nó tự động liên kết dữ liệu của nó.

Vì vậy, bạn muốn

## == Provides various utility features 
## 
## == Features 
## 
## Logging: logging is provided by the {Mysoft::Mypackage::Utility::Logger} class 
##