2015-06-19 27 views
16

Tôi đang chạy phpdoc trên dự án của mình và có tệp (tệp chỉ có ý nghĩa), trong đó thứ tự các phương pháp quan trọng đối với các phương pháp nhóm. Làm cách nào tôi có thể có cùng thứ tự các hàm trong tài liệu được tạo như trong tệp nguồn?Lưu thứ tự chức năng trong phpdoc

Thực ra, tôi đã sẵn sàng thay đổi khung tài liệu, nếu nó giúp.

+1

Mặc dù đây không phải là một câu hỏi không tốt, phải dựa vào thứ tự các hàm/phương pháp là thực hành không tốt (ít nhất là bằng PHP). – DanFromGermany

+2

@DanFromGermany: Có, nhưng có thể từ quan điểm tài liệu bạn muốn các hàm liên quan được nhóm lại với nhau. Loại giống như php.net, nơi các hàm mảng không được trộn lẫn với các chức năng PDO vv ... – AbraCadaver

+2

Nếu bạn có một vài nhóm hàm bên trong lớp/tệp php đơn lẻ - tôi khuyên bạn nên chia chúng thành các lớp/không gian tên khác nhau –

Trả lời

-2

Tôi nghĩ rằng không thể khai báo một đơn đặt hàng cụ thể.

Có thể xây dựng @package s tho, có nghĩa là cho không gian tên trong PHP (afaik ..).

Nếu bạn đã khai báo @package, bạn có thể xác định @subpackage s cho các phương pháp/chức năng nhóm.

<?php 
namespace Stackexchange\Stackoverflow; 
/** 
* My Answer 
* @package Stackexchange\Stackoverflow 
* @see http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.subpackage.pkg.html 
*/ 

class Answer 
{ 
    /** 
    * @subpackage SomeSubGroup 
    * @return $this 
    */ 
    public function doSomething { 
     return $this; 
    } 

    /** 
    * @subpackage SomeOtherSubGroup 
    * @return $this 
    */ 
    public function doSomethingDifferent { 
     return $this; 
    } 
} 

Bên cạnh tính năng nhóm, bạn nên cố gắng cải thiện chương trình của mình bằng cách chia lớp học ngữ nghĩa và logic thành các phần kinh doanh nhỏ hơn.

+0

Có những lý do hợp lệ để duy trì trật tự chức năng không liên quan gì đến thực hành OO kém. Đặc biệt trong tài liệu. – Cypher

+0

Thật không may, các yêu cầu của dự án làm cho tôi sử dụng đồng bằng phong cách insead của OOP. –

3

Thật không may, nó không xuất hiện ở đó là một cách để nói với Documenter gì để liệt kê các phương pháp trong.

Tuy nhiên, @see có thể hữu ích để bạn thu hút sự chú ý đến các chức năng liên quan. Điều đó kết hợp với một lưu ý trong mô tả đầy đủ về thứ tự cần thiết, hoặc một số ngoại lệ đặt hàng có thể là công cụ tốt nhất hiện có thể cung cấp.

+0

Tôi thích câu trả lời của bạn và tôi sẽ trao giải thưởng với tiền thưởng nếu không có câu trả lời nào tốt hơn. –

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