2010-10-08 30 views
19

Làm cách nào để ghi lại các hằng số lớp cho phpDoc? Tôi đã đọc hướng dẫn nhưng tôi không thể tìm thấy bất cứ điều gì về họ.phpDoc lớp hằng số tài liệu

+1

sử dụng '@ var' là đúng cách để làm điều đó, hãy xem https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#722-var – m13r

Trả lời

10

Tôi khá chắc chắn rằng bạn có thể sử dụng @const, mặc dù tôi không thể tìm thấy bất kỳ tài liệu tiếng Anh nào. Có một ví dụ của Đức here. Nó hiển thị các câu lệnh define thay vì các hằng số lớp, nhưng cú pháp IIRC giống nhau.

+0

Tôi không biết lý do tại sao nó không được tài liệu nhưng nó có vẻ làm việc, cảm ơn ... – mck89

+6

Xem xét tốt hơn về tài liệu '' const' là ở đây: http://stackoverflow.com/a/18446766/367456 - nó cũng giải thích rằng không có điều như vậy tồn tại. – hakre

+3

Nên sử dụng '@ var' theo câu trả lời này: http://stackoverflow.com/a/27772200/2053165 – Leith

29

Hằng số chỉ cần một tài liệu có chứa mô tả. Không cần thẻ cụ thể. Trình phân tích mã tự xác định các hằng số và hiển thị chúng như trong tài liệu được tạo ra (here's an example).

+2

Điều này có vẻ phù hợp với [phpDocumentor] (http://phpdoc.org/), nhưng để cho Netbeans biết mô tả để hiển thị trong tự động hoàn thành, người ta phải thêm '@ const' như được mô tả trong câu trả lời khác. – feeela

+0

Đây là những gì tôi sử dụng: http://stackoverflow.com/a/24042505/244826 – Sonny

Các vấn đề liên quan