我目前正在为一个RestfulAPI构建一些phpdoc-我开始使用@paramdoc语法来通过POST标记所需的参数。但是，在生成phpdoc之后，我注意到它拒绝列出这些参数，除非它们与方法本身的输入变量完全匹配。@uses和@see在涉及phpdoc输出时看起来不太好，也没有多大意义。文档的样式/外观与@param功能完美融合。是否有任何方法可以覆盖PHPDoc制定的规则，并允许它在文档中生成@paramblock，即使该参数不存在于方法本身中？ 最佳答案 如果您想记录您的API，我建议您使用适当的工具，例如APIBluepri
很难说出这里要问什么。这个问题模棱两可、含糊不清、不完整、过于宽泛或夸夸其谈，无法以目前的形式得到合理的回答。如需帮助澄清此问题以便重新打开，visitthehelpcenter.关闭10年前。社区在6个月前审查了是否重新打开这个问题，然后将其关闭:原始关闭原因未解决我正在寻找将PHPDocblock(用于通过Doxygen等工具生成文档)转换为我可以在PHP中检查的结构的方法。比如我要解析/***Multiplytwovalues*@CHECKME**@authorsomeone*@createdeonsago**@paraminteger$x*@paraminteger$x**@r
关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题，以便用事实和引用来回答。关闭4年前。Improvethisquestion我正在使用Eclipse+PDT进行开发。我一直在我的代码中添加phpdoc注释，但实际上从未在Eclipse中生成结果文档。我应该怎么做-Eclipse中是否有一些功能，或者文档生成应该在外部完成？
我非常喜欢在Notepad++中工作，但我还没有找到一个插件来自动执行PHPDoc风格的注释。其他PHPIDE(Eclipse、NetBeans、ZendStudio)包括此功能，而且非常方便。基本上我想要的是，如果在我输入的函数定义或类定义上方的行中:/**它会自动填充PHPdoc格式(类似下面的函数):/****@param$first_argument*@param$second_argument*@return*/然后，当我在评论中输入额外的行时，它会以星号开头每行。是否有一个NP++插件可以完成这个，或者有什么方法可以调整NP++使其工作？ 最佳答
在使用PHPDoc描述变量时，我对何时使用null作为类型感到困惑。类型提示是否应该描述外部调用者预期和遵守的希望和期望，或者它们是否应该记录变量的所有可能类型，即使希望它在实践中是一种非常具体的类型？示例1:默认值。以下函数只需要非空值。但如果没有传递任何值，它默认为null并明确检查该值作为确定是否传递任何内容的一种方式，并为该情况返回一个特殊值。希望没有外部调用者会传递除整数以外的任何内容。null应该像下面那样在@param类型中使用，还是应该只指定int因为这是我们想要传递的东西，如果有任何传递的话？/***@paramint|null$bar*/functionfoo($b
是否有用于注释C#代码的标准约定(如phpdoc或python的文档字符串)，以便可以从源代码自动生成类文档？ 最佳答案 您可以使用XML样式的注释，并使用工具将这些注释提取到API文档中。这里是评论样式的例子://////Authenticatesauserbasedonausernameandpassword.//////Theusername.///Thepassword.//////True,ifauthenticationissuccessful,otherwiseFalse./////////Forusewithloca
是否有用于注释C#代码的标准约定(如phpdoc或python的文档字符串)，以便可以从源代码自动生成类文档？ 最佳答案 您可以使用XML样式的注释，并使用工具将这些注释提取到API文档中。这里是评论样式的例子://////Authenticatesauserbasedonausernameandpassword.//////Theusername.///Thepassword.//////True,ifauthenticationissuccessful,otherwiseFalse./////////Forusewithloca
有没有办法标记一个magicproperty作为弃用？考虑以下简化代码:/***Exampleclass**@propertystring$fooAfoovariable.*/classExample{/***Magicgetter*/publicfunction__get($var){if('foo'===$var){//do&returnsomething}}}现在，如何指示其他开发人员，他们不应该再使用Example::$foo了？我想到的唯一可行的解决方案是:/***Exampleclass*/classExample{/***Afoovariable.**@varstri
有没有办法标记一个magicproperty作为弃用？考虑以下简化代码:/***Exampleclass**@propertystring$fooAfoovariable.*/classExample{/***Magicgetter*/publicfunction__get($var){if('foo'===$var){//do&returnsomething}}}现在，如何指示其他开发人员，他们不应该再使用Example::$foo了？我想到的唯一可行的解决方案是:/***Exampleclass*/classExample{/***Afoovariable.**@varstri
在PHP7中，当一个方法设置给定的参数类型和结果类型时，是否有必要在PHPDoc中再次记录它们？自functionfoo(string$text):bool{returntrue;}相当于/***@paramstring$text*@returnbool*/functionfoo($text){returntrue;}是否有必要复制这些信息？/***@paramstring$text*@returnbool*/functionfoo(string$text):bool{returntrue;}编辑:我不使用PHPDoc生成我的代码文档，而是在PHPStorm的帮助下为我和我的同事保持方
