PHP 注释格式 : auto generated or User created?

标签 php documentation formatting

一直在php中看到这些header注释,经常想是不是用什么软件设置的?我好像记得 JavaDoc 什么的?但我不确定这是否是自动生成的?或者这只是某种类型的文档标准?

下面的例子来自CodeIgniter :

/**
 * CodeIgniter
 *
 * An open source application development framework for PHP 4.3.2 or newer
 *
 * @package     CodeIgniter
 * @author      ExpressionEngine Dev Team
 * @copyright   Copyright (c) 2008, EllisLab, Inc.
 * @license     http://codeigniter.com/user_guide/license.html
 * @link        http://codeigniter.com
 * @since       Version 1.0
 * @filesource
 */

我真的很想改进我的评论,我觉得这对我的项目来说是一种很好的形式。

最佳答案

phpDoc一些框架使用反射来动态理解和使用类(通过代码本身)。

IDE 还将使用它来自动完成、显示函数参数等。了解您的 IDE 是否为您使用的框架提供了这些功能,而不是为您编写的代码提供了这些功能,这是一件好事。

PHP's Reflection API

Zend Framework Extension (including DocBlocks)

CodeIgniter's Comment Guide (Using DocBlock '...so they can be picked up by IDEs')

DocBlock Description on phpdoc.org (linked from CI's Style Guide)

关于PHP 注释格式 : auto generated or User created?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/1411413/

相关文章:

php - laravel 模型获取具有自定义值的数据

php - friend ,我尝试将HTML表单中的数据插入Mysql数据库,但它不起作用,也找不到错误

c# - 我应该如何为我的网络服务 API 生成文档?

c# - 在 C# 中使用文档属性

java - 如何统一来自 java 堆栈的日志记录格式

html - 在电子邮件正文中应用 HTML 格式

switch语句中的php空值混淆

php - 用于显示语法高亮显示的 HTML5 标记

api - 使用 Swagger 和 ServiceStack 记录响应类

c# - 像 facebook 一样格式化时间