tôi ghi lại oo mã của tôi theo cách sau:
- Vào đầu của tập tin có chứa 'classdef', tôi viết một bản tóm tắt về những gì lớp nào, và sử dụng điển hình. Tôi cũng giải thích chi tiết các thuộc tính và tôi thêm một mô tả 1 câu của mỗi phương pháp.
- Sau mỗi định nghĩa thuộc tính, tôi thêm một câu giải thích về nó (trên cùng một dòng)
- Mỗi phương pháp được viết thành một hàm, tức là nó có dòng H1, tóm tắt và giải thích đầu vào và thông số đầu ra.
Khi bạn gọi 'doc myClass', bạn sẽ thấy (1) ở đầu, tiếp theo là danh sách các thuộc tính được giải thích bởi các câu bạn đã thêm vào (2) và danh sách các phương pháp hiển thị H1- dòng và phần còn lại của trợ giúp (3) nếu bạn nhấp vào liên kết. Ngoài ra, tất cả các lớp của tôi phân lớp một siêu lớp chung thực hiện (trong số những người khác) phương thức 'help' gọi doc (class (obj)), cho phép tôi đưa ra sự trợ giúp từ mọi cá thể của lớp.
Ví dụ
%# MYCLASS is a sample class
%# All this text will show up at the top of the help if you call 'doc myClassName'
%#
%# myClass is an example for documentation. It implements the following properties and methods:
%# PROPERTIES
%# myProp - empty sample property (some more explanation could follow here)
%#
%# METHODS
%# myMethod - sample method that calls doc
%#
classdef myClass
properties
myProp = []; %# empty sample property
end %# properties
methods
%%# MYMETHOD -- use %% so that you can easily navigate your class file
function myMethod(obj)
%#MYMETHOD calls up the help for the object
%#
%# SYNOPSIS myMethod(obj)
%# INPUT obj: the object
%# OUTPUT none
%#
try
doc(class(obj))
catch
help(class(obj))
end
end %#myMethod
end %#methods
end %#myClass
Sửa 1 Nếu bạn muốn có một tài liệu html thoải mái, bạn có thể, ngoài ra, sử dụng m2html để tạo ra nó cho bạn. M2html sẽ thu thập các văn bản trợ giúp và thậm chí nó có thể làm đồ thị phụ thuộc.
Chỉnh sửa 2 Trong khi m2html tài liệu mã Matlab chuẩn độc đáo, nó không có hỗ trợ cụ thể cho lớp. Điều này có nghĩa là bạn nhận được các phương thức như là 'các hàm con' được liên kết trong lớp, nhưng bạn không nhận được một bản tóm tắt tốt đẹp như bạn nhận được với Doxygen, hoặc bạn nhận được với trình duyệt tài liệu dựng sẵn.
Đây chính xác là những gì tôi đang tìm kiếm, cảm ơn bạn. – jjkparker