问题标签 [ghostdoc]

我正在使用 GhostDoc 来记录我的方法等......并且它运行良好，但它并没有填补<returns>......

谁能告诉我我应该做什么，即

如果它返回一个名为“角色”的对象，那么

或者干脆

或者

我知道它的声音有点太精确了，但我想从正确的开始:-)

以用户名的标准字符串返回类型为例

有没有办法让 ghost doc 修改方法的现有 XML 注释（由 Ghost doc 制作）以在您重新运行该方法时添加“修改者”行？

我个人认为这就是源代码控制的用途，但他们想在 XML 中做到这一点，所以这是一个新的工作要求。

我有一个ISomeInterface带有完整 xml 注释的接口 ()，以及一些带有匹配 xml 注释的派生类。

如果我更改界面中的注释，是否可以使用 GhostDoc（或任何其他工具）更新所有派生类中的注释？

我很欣赏这在某些情况下可能会导致不需要的更改，但在这种情况下我并不担心。

如何配置 GhostDoc 来为属性的属性生成注释，例如：

GhostDocs 的重点显然是记录您的代码。它要求您很好地命名您的方法。然而，对于命名良好的方法，理论上它们不应该足够有用以被视为文档吗？

我只想听听当前用户的一些优点/缺点，因为我不想下载它并用不必要和重复的文档弄乱我的代码。

回到我的 C# 时代，我喜欢使用名为“GhostDoc”的 Visual Studio 扩展。现在我被用作 Java 开发人员，我正在使用 Eclipse。我可以在没有推断文档的情况下生活，但我想做的是智能地“修复”我的文档。例如，假设我有以下方法：

后来在开发过程中，我意识到允许我的方法的消费者传入一个 qux 值会很有用。不仅如此，将它作为第一个参数是最有意义的。此外，我将让该方法抛出我超级有用的 FooBarException。所以现在我的方法看起来像这样：

作为一名优秀的开发人员，我希望我的更改反映在我的 JavaDoc 中。在 GhostDoc 中，我可以点击我的文档快捷键，它会添加新内容而不会干扰旧内容。在 Eclipse 中，它呈现了一组全新的 JavaDoc，我必须做一堆复制粘贴。如何在不丢失我当前拥有的 JavaDoc 的情况下自动将 new @param、@exception和 missing参数放入我的 JavaDoc 中？@returns

在 GhostDoc Pro 的“规则”设置中，它允许我使用 T4 来格式化我的评论。然而，它随机添加换行符（我已经整理出来），并且也不允许我添加一行三重斜杠。

例如：

我试过添加一个 StringBuilder.Append("///"); 我试过只是简单地添加三个斜杠。然而，GhostDoc Pro 似乎删除了任何会添加空白三重正斜杠注释行的 T4 或 C# 代码行。

我觉得我忽略了一些简单的事情。

如何自定义 GhostDoc 以执行以下操作？

基本上我想在评论的开头加上作者，在评论的最后加上日期时间。

我正在使用 GhostDoc 创建我的 XML 注释，我对这种格式非常满意。我使用以下格式（c#）

使用 R# 7.1.1 中的代码清理，它会重新格式化我的 xml 注释，它甚至会在缺失的地方插入新的 xml 注释，这真的很烦人。有没有办法阻止这种情况。

我已经为代码清理创建了自己的配置文件并禁用了所有内容（甚至是 stylecop 设置），我进行了代码清理，果然它想重新格式化我的 xml 注释并将新的注释放在它们丢失的地方..

有谁知道如何解决这个问题？

谢谢

如何将 GhostDoc 配置为仅评论公共访问者？我查看了“规则”配置，但没有看到任何指示访问器类型的信息/变量。