2016-04-25 77 views
-4
所有可用的標籤

enter image description here最佳途徑,像@author

我在GitHub上項目https://github.com/qzoke/isbn-converter 工作,我想創建一個漂亮的貢獻頭部。所以這裏是我的問題:

  1. 所有變量或任何像@author可用。

幾個,我知道有:

@author 
@license 
@version 
@package 
@subpackage 
  • 最佳展示像
  • 幾個使用

    @author www.website.com 
    

    幾個值的方式使用

    @author name<email> 
    

    有的只是

    @author name. 
    
  • 如何,什麼應該是包和子包名。子包是混亂的,不知道我是否應該在子包或相同的包名中使用文件名。

  • 可以在那裏寫描述,關鍵詞,貢獻。

  • 什麼是引用許可證,只是名稱(如GNU GPL v3.0)或名稱+網絡鏈接或鏈接到本地​​副本或整個許可證文本副本的最佳方式。

  • 哪些文件應該有這樣的標題,只是index.php或header.php或其他。

  • 什麼包括在html評論,如果有的話。

  • +0

    這又是如何得到-5分數在3分鐘內?這不是一個可怕的問題...... –

    +2

    @MattiVirkkunen似乎是一整套問題,沒有任何跡象表明提問者試圖取得任何進展。 – Richard

    +0

    是的,但是-5?這是如何發生的 –

    回答

    1

    按照https://phpdoc.org/文檔有一些通過https://phpdoc.org/docs/latest/index.html列出的phpDocumentor的認可標籤。

    實施例源https://phpdoc.org/docs/latest/references/phpdoc/tags/author.html

    Syntax: @author [name] [<email address>]

    的@author標籤可以被用來指示誰創建了結構元件或已取得顯著修改它們。這個標籤可能還包含一個電子郵件地址。如果提供了一個電子郵件地址,它必須遵循作者的名字幷包含在V形或尖括號中,並且必須遵守RFC5322第3.4.1節中定義的語法。

    您可以使用PHPDoc的文檔回答所有觀點。

    幾道PHPDoc的標籤是:

    @abstract 
    @access 
    @author 
    @copyright 
    @deprecated 
    @deprec 
    @example 
    @exception 
    @global 
    @ignore 
    @internal 
    @license 
    @link 
    @name 
    @magic 
    @package 
    @param 
    @return 
    @see 
    @since 
    @static 
    @staticvar 
    @subpackage 
    @throws 
    @todo 
    @var 
    @version 
    

    你可以找到更多的https://en.wikipedia.org/wiki/PHPDoc