在 PhpStorm 中添加单行注释

Question

我如何让PhpStorm在使用简短的PHPDoc注释时将注释显示为单行而不是多行？

目前的显示方式：

/**
 * @return int[]
 */
public static function defaultAccountValidationCollection(){}

我想要这个：

/** @return int[] */
public static function defaultAccountValidationCollection(){}

- Mohsen

---

@SimoneRossaini 因为//comment不是PHPDoc注释。 - LazyOne

哦，抱歉我不知道，这个链接或许可以帮助楼主 link。 - Simone Rossaini

@Mohsen，你想生成单行注释...还是以更紧凑的方式显示它？显示：好吧，你可以折叠它（自动折叠也可用）。否则，我不知道为什么这里需要显示带有@param或其他行的注释。生成：当你有@param时，它应该是什么样子？无论如何：设置|文件和代码模板——你可以在那里调整一些东西。 - LazyOne

这是关于编码风格的问题，我建议阅读更多关于 https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#5-the-phpdoc-format 的内容。当你开始使用linter时，你会收到警告信息：/** @return int[] */。如果有人要求你这样做，请确保他们也阅读了相关内容。 - Ersin Demirtas

我猜你不是想打出/** 然后按空格键吧？ - Tropus

Answer 1

您可以像这样更改PhpStorm的函数文档注释模板： /** ${PARAM_DOC} #if (${TYPE_HINT} != "void") @return ${TYPE_HINT} #end ${THROWS_DOC} */

但是单行文档的方式并不实用。因为函数可以接受多个参数，可以返回不同的对象，可以有适当的解释说明其功能。为什么要限制自己呢？

您可以在变量和属性上使用单行文档。在它们上面写：/**，然后按下空格键。

- Enver Arslan

Answer 2

你可以尝试使用：

PhpStrom - 编辑器 - 文件和代码模板 - 包含 PhpStrom - 编辑器 - 文件和代码模板 - 包含

#if (${PARAM_DOC} == "") && (${THROWS_DOC} == "")
    /*** @return ${TYPE_HINT} */
#else
/**
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT} #end
${THROWS_DOC}
*/
#end

- ZaNdaLeX

---

什么是“this”？请通过编辑您的答案添加所有澄清，并请避免使用图像作为答案的唯一内容。 - Nico Haase