2010-08-28 24 views
5

Làm cách nào để tài liệu có một số biến tham số? Tôi đang viết một ứng dụng bằng PHP và JavaScript. Hiện tại tôi có (trong JavaScript):Làm cách nào để tài liệu về một số biến số tham số

/** 
* Description 
* @param {String} description 
*/ 
function fn() 
{ 
    // arguments holds all strings. 
} 

Vì vậy, làm cách nào để tôi có tài liệu về số tham số chuỗi?

+2

Không chắc liệu "doctype" có phải là lựa chọn đúng đắn của từ tại đây hay không. –

+0

Bạn có nghĩa là làm thế nào để viết các tham số trong jsdoc? – 2ndkauboy

+1

Bạn có yêu cầu Javascript hoặc PHP không? Mã của bạn là JS, nhưng bạn đã chấp nhận một câu trả lời PHP. Nếu PHP của nó, hãy thay đổi (hoặc loại bỏ) ví dụ và cũng loại bỏ các thẻ javascript và jsdoc. Đối với JS, đã có câu trả lời cho câu hỏi được liên kết này (http://stackoverflow.com/questions/4729516/correct-way-to-document-open-ended-argument-functions-in-jsdoc). – studgeek

Trả lời

12

Ví dụ: PhpDocumentor đề xuất sử dụng dấu ba chấm

/** 
* Example of unlimited parameters. 
* Returns a formatted var_dump for debugging purposes 
* (since the recurrences of $v are not listed in the actual function signature in the code, 
* you may wish to highlight they are "optional" in their description) 
* @param string $s string to display 
* @param mixed $v variable to display with var_dump() 
* @param mixed $v,... unlimited OPTIONAL number of additional variables to display with var_dump() 
*/ 
function fancy_debug($s,$v) 
{
+3

Đánh tôi với nó. Tham khảo: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html –

+0

Điều này dường như không hoạt động nữa khi sử dụng phpDocumentor2 – ChrisF

+1

Điều gì sẽ xảy ra khi nó hoàn toàn là varargs như 'function foo() { $ args = func_get_args(); ...} '? – SeldomNeedy

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