Tài liệu nhận xét mục tiêu-C trên/** @discussion @param @see @return .... */

Question

Tôi đã thấy ngày càng nhiều loại @marker này có nhận xét trong/** */và tôi ' m tìm kiếm một số tài liệu, giải thích về chúng là gì và cách sử dụng nó. Cảm ơn!

/** 
@param blabla... 
@return bla... 
@see ... 
@method ... 
@discussion ... 
*/ 

Answer 1

Đây là tài liệu nội tuyến (tốt, trong nhận xét), cách tiếp cận đặc biệt để tự viết mã. Kiểu đặc biệt này được gọi là kiểu Javadoc và ngoài công cụ Javadoc, rất nhiều trình tạo tài liệu phổ biến hỗ trợ nó, bao gồm Doxygen và Appledoc.

Mục đích ghi tài liệu của một số mã (ứng dụng, thư viện, v.v.) là các nhà phát triển không cần duy trì cấu trúc tệp riêng lẻ cho cấu trúc tệp và; các tiện ích tự động này có thể tạo tài liệu được định dạng độc đáo (ví dụ, HTML) từ thông tin được nhúng trong các nhận xét.

Cũng lưu ý rằng đây không phải là tính năng phụ thuộc vào ngôn ngữ. Đừng nhầm lẫn với các ký hiệu @ (at), đây không phải là cú pháp cụ thể của Objective-C (đúng hơn là nó dành riêng cho chương trình tạo tài liệu cụ thể được sử dụng).