【问题标题】:How to change method comments after a modification修改后如何更改方法注释
【发布时间】:2011-11-04 08:49:27
【问题描述】:

我正在使用 aptana 编辑器,它会自动在实现类的方法中添加 phpdoc,例如

/**
* (non-PHPdoc)
@see trunk/library/Storage_interface::get()
*/   

如您所见,Storage_interface 是主要的接口类。现在让我们说接口类名称发生了变化。如何在所有已实现的方法 cmets 中反映修改后的名称?除了手动更新还有什么办法吗?

【问题讨论】:

  • 我会尝试删除 phpdoc 然后重新生成它

标签: php aptana phpdoc


【解决方案1】:

据推测,该文档块中 @see 标记的自动填充是在此子类/实现类的相同命名方法 (get()) 之上自动生成的空文档块的结果。因此,如果您要更改父类或接口中的方法名称,那么您还必须在此处更改代码中的方法名称。因此,您仍然可以在 @see 链接中使用新方法名称更新此文档块。

【讨论】:

  • hmm.. 所以除了在这种情况下手动更新文档块之外没有其他选项。
  • 正确的 CM... 但同样,在这种情况下,在您正在查看的方法中更改您正在覆盖的父项中的方法名称的情况下,您必须手动更改您的方法名称自己的代码就在您面前。因此,您已经在相关的文档块中,因此您可以手动更新 @-see 标记引用的类名。当然,如果您删除 docblock,然后重新开始编写它,那么它的自动填充将选择正确的名称。
  • 我认为删除并重新启动该子类方法上的文档块所产生的“自动化”可能会被认为有一些好处。至少,它确实创建了带有完全路径父方法字符串的@see 标记...
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2021-12-30
  • 1970-01-01
  • 1970-01-01
  • 2019-07-03
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多