Question

无论我走到哪里，我都会看到php的文档，其中包含以下内容：

/*
* stuff 
* stuff 2
*/

我的问题是我可以逃脱：

/* 
Stuff 1 
Stuff 2
*/

或者是出于某种原因反击表示感谢？

Answer 1

简单地说，是的，你可以！

创建.php文件时，开发人员通常会插入注释，以便为其编码添加解释。

添加评论有两种方法。它们如下：

/*[Comment Here]*/这允许开发人员添加分布在多行的注释。例如：

/* [This is a Comment] [This is also a Comment] */

您只需确保您的评论属于/**/，并且这些评论都包含在<?php [Code Data] ?>代码中。

或者，您可以使用'//'。与上述不同，这只允许您在一行上插入注释。如果您要进入下一行，则需要添加额外的//。如上所述，您还需要确保将这些//放在<php? [Code Data] >代码中。

至于'*'列表，我认为这只是出于表现和组织目的。它们当然不会影响评论本身。

Answer 2

通常，当您看到遵循特定模式的编码习惯时，其原因可能是以下原因之一：

评论通常是后两者。

/**/注释块有许多编码样式，跨多种语言（不仅仅是PHP）。编码风格通常只是个人/团队偏好，通常有一些真实的论据，为什么一个特定的习惯是首选。通常，可读性是王道。

这些特定评论风格中最常见的是所谓的DocComment或DocBlock。

这是一种以编程方式直接从注释中生成文档的方式。因为注释是由代码解析的，所以它使用特定模式指定（注意/**前缀），使事情更易于检测和重新格式化：

/**
 * This is my DocBlock
 *
 * Each new line is prefix with a *
 * and any special attributes are
 * prefixed with an @something
 */

您绝不必这样做，简单的/*和*/就足以支持多行注释。在我过去曾参与过的项目中，在每一行上使用*之间的区别并不是在评论是真正的评论时明确，而是在它被用来评论一部分时代码。

Answer 3

您描述的格式称为PHPDoc。它经常用于记录类和方法（IDE可以使用PHPDoc）。有时需要此注释格式来存储各种框架和库的注释（例如，Symfony在控制器上使用它进行路由。）

如果您没有使用注释或记录类/函数，那么没有理由在PHPDoc约定中编写。

PHPDoc的：

Symfony注释示例（请参阅@Route示例）：