Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/solr/3.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
用php和所有可用标记(如@author)编写贡献标题的最佳方法_Php_Phpdoc - Fatal编程技术网

用php和所有可用标记(如@author)编写贡献标题的最佳方法

用php和所有可用标记(如@author)编写贡献标题的最佳方法,php,phpdoc,Php,Phpdoc,我正在从事一个GitHub项目 我想创建一个好的贡献标题。下面是我的问题: 所有变量或类似@author的变量都可用 我知道的很少有: @author @license @version @package @subpackage 展示价值观的最佳方式,如 少用 @author www.website.com @author name<email> 少用 @author www.website.com @author name<email> 包和子包的名称应该是什

我正在从事一个GitHub项目 我想创建一个好的贡献标题。下面是我的问题:

  • 所有变量或类似@author的变量都可用
  • 我知道的很少有:

    @author
    @license
    @version
    @package
    @subpackage
    
  • 展示价值观的最佳方式,如
  • 少用

    @author www.website.com
    
    @author name<email>
    
    少用

    @author www.website.com
    
    @author name<email>
    
  • 包和子包的名称应该是什么以及如何命名。子包很混乱,不知道我应该在子包中使用文件名还是使用相同的包名

  • 可以在那里写描述、关键词、贡献吗

  • 引用许可证的最佳方式是什么,只需名称(如GNU GPL v3.0)或名称+Web链接,或链接到本地副本或整个许可证文本的副本

  • 哪些文件应该有这样的头,只要index.php、header.php或每隔一个

  • 以及html注释中包含的内容(如果有)

  • 根据文件,PHP文件中列出了许多可识别的标签

    示例源

    语法:@author[name][]

    @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
    

    你可以在

    中找到更多信息,这是如何在3分钟内得到-5分的?这不是一个可怕的问题…@MattiVirkkunen似乎是一整套问题,没有任何迹象表明提问者试图取得任何进展。是的,但是-5?这是怎么回事happen@MattiVirkkunen不是-5,这是6个向下投票和一个向上投票。这个问题最初被标记为php(一种编程语言),但绝对不是一个编程问题。为了获得正确的反馈,需要使用正确的标签,