2010-02-03 28 views
11

Chúng ta phải ghi lại như thế nào (với phpDocumentor) các hằng số được định nghĩa với define() trong PHP?Cách chính xác để ghi lại các hằng số PHP (định nghĩa) bằng phpDocumentor

tôi thấy không có gì trong các tài liệu, nhưng không tìm thấy ví dụ sau (mà tôi không thấy đó là sử dụng) trong sample2.php:

/**#@+ 
* Constants 
*/ 
/** 
* first constant 
*/ 
define('testing', 6); 
/** 
* second constant 
*/ 
define('anotherconstant', strlen('hello')); 

Bất cứ ai có thể cho tôi biết cách tốt nhất để ghi lại hằng là những gì trong PHP với phpDocumentor?

Trả lời

6

Xác định các câu lệnh nói chung chỉ được nhận xét bằng văn bản mô tả, do đó, về cơ bản là cách bạn nhận xét nó.

Để đọc thêm về thẻ mẫu DocBlock, /**#@+, hãy kiểm tra the manual page.

+0

Không có thẻ nói riêng là cần thiết. "Thẻ mẫu" xuất hiện ở đầu ví dụ của bạn chỉ có dưới dạng lối tắt * thêm * phần mô tả "Constants" của bạn vào từng mô tả riêng lẻ của bạn ("hằng số đầu tiên", "hằng số thứ hai"). Việc sử dụng thẻ mẫu đó chỉ cần thiết nếu bạn thực sự muốn đặt một số văn bản phổ biến vào nhiều mô tả riêng biệt. – ashnazg

+0

Tất cả các liên kết đều chết – Loenix

0

Bạn có tại phpDoc.org the elements that can be documented.

Bạn cũng có an example of documenting a define() (đoạn mã thứ hai và các đoạn xung quanh).

+2

Ví dụ đó thực sự cố gắng chứng minh rằng có câu lệnh "define" không đúng giữa hàm foo() và docblock của hàm sẽ làm cho docblock được liên kết không chính xác với hằng số được xác định thay vì hàm. Tôi không thực sự nhìn thấy một ví dụ hữu ích trong hướng dẫn để hiển thị tài liệu một hằng số, vì vậy tôi tìm thấy một trong một trong những tập tin phpDocumentor của chính nó ... nhìn vào dưới cùng của trang ở đây (http://manual.phpdoc.org/ HTMLSmartyConverter/HandS/__ filesource/fsource_phpDocumentor_Parsers_phpDocumentorConvertersXMLDocBookpeardoc2Tokenizer.php.html). – ashnazg

+1

Tất cả các liên kết đã chết – Loenix

+0

Dự án đã thay đổi vị trí của tài liệu. Vị trí mới: https://phpdoc.org/docs/latest (Xin lỗi, tôi không thể tìm thấy các phần tôi đã đăng) – xOneca

1
/** 
*@const 
*/ 
const testing=6; 
const anotherconstant=strlen('hello'); 

Hãy thử điều này bạn sẽ xem nó như là liên tục

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