2016-04-25 121 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