Php 标准变更意见

我正在寻找一些关于PHP中注释更改的标准格式的方向。在与各种各样的开发人员进行大规模项目的工作时，评论会不断出现，在大多数情况下，更改要么评论不好，要么根本就没有评论

下面是一个示例，请随意扩展：

/** * Author: [first and last name] * Date Changed: [YYYY-MM-DD] * Description: [description] */ /** *作者：[姓名] *更改日期：[YYYY-MM-DD] *描述：[描述] */ 问：有人知道一种标准化的方法来评论PHP中的更改吗？

这样的东西不应该放在文件评论中。使用存储文件的所有版本（不仅仅是最新版本）。绝不允许开发人员在没有它的情况下工作。这类软件允许您对源代码进行更多操作：

• 您可以找到谁更改了文件的每一行
• 您可以将文件还原到以前的（或工作）版本
• 您可以创建源的不同分支并自动合并它们
• 您可以自动构建软件并自动运行测试
• 备份您的源存储库，您将永远不会丢失您的工作
• 这些东西不应该放在文件注释中。使用存储文件的所有版本（不仅仅是最新版本）。绝不允许开发人员在没有它的情况下工作。这类软件允许您对源代码进行更多操作：
  • 您可以找到谁更改了文件的每一行
  • 您可以将文件还原到以前的（或工作）版本
  • 您可以创建源的不同分支并自动合并它们
  • 您可以自动构建软件并自动运行测试
  • 备份您的源存储库，您将永远不会丢失您的工作

  • ---

  除了使用源代码管理之外，注释通常应该关注源代码的当前状态，而不是提供详细的历史记录，也许除了解释性上下文
  注释应描述程序的方式和原因，而不是管理草稿或历史填写表格。这是一个工程师如何与另一个工程师沟通，或者提醒自己概念模型是什么。这可以解释实现的基础，例如其原理、预期用途或世界观。但正如你们所知，工程师不能被当作办事员
  我想我们都见过这样的来源：

  /*
   * Function:  (fill in name)
   *
   * Returns:  (fill in type)
   *
   * Date:  (current date)
   *
   * Revision (revision number)
   *
   * Author:  (your name or initials)
   *
   * Description:
   * (describe function)
   */
  

  ---

  除了使用源代码管理之外，注释通常应该集中在源代码的当前状态上，而不是提供详细的历史记录，也许除了解释性上下文之外
  注释应描述程序的方式和原因，而不是管理草稿或历史填写表格。这是一个工程师如何与另一个工程师沟通，或者提醒自己概念模型是什么。这可以解释实现的基础，例如其原理、预期用途或世界观。但正如你们所知，工程师不能被当作办事员
  我想我们都见过这样的来源：

  /*
   * Function:  (fill in name)
   *
   * Returns:  (fill in type)
   *
   * Date:  (current date)
   *
   * Revision (revision number)
   *
   * Author:  (your name or initials)
   *
   * Description:
   * (describe function)
   */
  

  ---

  除了最无用的细节，没有人填写任何内容。
  您使用过任何类型的源代码管理软件吗？这将自动更改作者和日期。根据SCM的不同，您可能会钩住提交操作，并要求此人添加描述更改的注释。您是否使用任何类型的源代码管理软件？这将自动更改作者和日期。根据SCM的不同，您可能会钩住提交操作，并要求此人添加描述更改的注释。+1。这种元数据（谁做的，什么时候做的）应该由版本控制管理，而不是由注释管理。注释应该用于帮助试图理解代码的人获得有用的信息，或者用于使用说明文件。+1。这种元数据（谁做的，什么时候做的）应该由版本控制管理，而不是由注释管理。注释应该用于为试图理解代码的人提供有用的信息，或者用于使用说明文档。