Tôi mới phát triển PHP và tôi tự hỏi liệu cộng đồng có bất kỳ hướng dẫn nào cho tài liệu nội tuyến về mã bằng cách sử dụng nhận xét hay không. Tôi thích một cái gì đó như Python PEP 257, nhưng tôi sẽ giải quyết cho một định dạng được sử dụng bởi một công cụ khai thác tài liệu phổ biến, hoặc thậm chí tiêu chuẩn tài liệu của một sản phẩm phổ biến.Có một phong cách tiêu chuẩn cho tài liệu trong PHP không?
Các hình thức sử dụng rộng rãi nhất của tài liệu API cho PHP là phpDocumentor PHPDoc a.k.a.. Rất nhiều IDE cũng có thể trích xuất thông tin để cải thiện gợi ý tự động hoàn thành bằng cách sử dụng tài liệu API kiểu phpDocumentor.
Sử dụng phpdoc (rất giống với javadoc)
PHPDoc là điều đầu tiên mà nói đến cái tâm, hãy nhìn vào http://www.phpdoc.org/
PEAR (và PHP Extension Application Kho) có coding standards rằng bao gồm một sample file bằng phpDocumentor, cũng như một số công ước hữu ích khác.
Kiểu phpdoc (phpDocumentor) là phổ biến. Nó sử dụng DocComments chứa DocBlocks.
<?php
/**
* This is a DocBlock for a function.
*/
function associatedFunction()
{
}
<?php
/**
* I belong to a file
*/
/**
* I belong to a class
*/
class Def
{
}
Thẻ và chú thích:
<?php
/**
* A summary informing the user what the associated element does.
*
* A *description*, that can span multiple lines, to go _in-depth_ into the details of this element
* and to provide some background information or textual references.
*
* @param string $myArgument With a *description* of this argument, these may also
* span multiple lines.
*
* @return void
*/
function myFunction($myArgument)
{
}