标签: ghostdoc

我也在Visual Studio 2008中使用GhostDoc.如何查看所有待办事项以及是否已经在Visual Studio或GhostDoc(我使用的文档工具)中的函数？

我在一个团队中工作,我们在StyleCop中使用了广泛的规则集,我想知道关于这样一个工具停止有用并且开始变得烦人的一般观点的想法.我们还使用GhostDoc,因此代码中充斥着XML注释,这使得代码更难以阅读并因此进行审查.我对XML注释没有任何问题,并且发现它们在某些地方非常有用,但它们是否真的需要在每个字段和属性上？

我们有一个令人钦佩的目标:"每个项目在构建时必须有0个警告"但当然这个目标需要违背合理的StyleCop规则集,否则会浪费宝贵的时间来"修复"StyleCop警告的原因.

有什么想法？

编辑 我现在真的想知道什么是像ALL ALL的stylecop工具的论据？为什么不放弃它,让合理的编码标准和良好的代码审查来处理其余的事情？特别是在一支优秀的团队中？当然,获得0警告的任务实际上会增加价值,因为所有警告都是相关的.

我认为GhostDoc的唯一优势是它可以为您从头开始编写XML注释节省大量时间.我不认为你应该接受生成的评论而不进行编辑 - 这可能适得其反.

这是由GhostDoc生成的xml注释满足的Stylecop规则(SA1642:ConstructorSummaryDocumentationMustBeginWithStandardText)的组合 - 是否在一天结束时添加任何值？

    /// <summary>
    /// Initializes a new instance of the <see cref="SomeCustomType"/> class.
    /// </summary>
    /// <param name="someParameter">The someParameter.</param>
    public SomeCustomType(string someParameter)
    {
    }

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

/**
 * Gets a collection of {@link Foo} objects
 * @param bar The bar level
 * @param baz The bazziness
 */
public Collection<Foo> getFoos(int bar, int baz)
{
    // Do something cool
}

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

/**
 * Gets a collection of {@link Foo} objects
 * @param bar The bar level
 * @param baz The bazziness
 */
public Collection<Foo> getFoos(String qux, int bar, int baz) throws FooBarException
{
    // Do something cool
}

作为一名优秀的开发人员,我希望我的更改能够反映在我的JavaDoc中.在GhostDoc中,我可以点击我的文档快捷键,它会添加新的东西,而不会打扰旧的东西.在Eclipse中,它呈现了一整套新的JavaDoc,我必须做一堆复制面食.我怎么能自动将新@param,@exception以及缺少@returns参数到我的JavaDoc不失,我目前拥有的JavaDoc的？

我是GhostDoc在Visual Studio中生成自动注释的忠实粉丝所以我正在寻找一个插件,它在Eclipse中使用我的Java代码完成同样的工作.有什么建议？

当我在C#中开发时,我大量使用GhostDoc来加速评论我的代码的过程.我目前正在开发一个C++项目,但我还没有找到一个等效的工具.我知道Doxygen,但据我所知,它用于在代码之外创建文档,而不是代码中的注释.有没有好的等效工具？我更喜欢在VS中运行的一个,但我可以处理在任何IDE中运行的一个.

(在有人提出之前,我并不仅仅依靠GhostDoc来创建评论.我只是用它来创建评论的起点.)

我在晚年变得懒惰.对于我的C#作品,我已经非常依赖Roland Weigelt 为Visual Studio提供的出色的GhostDoc插件.

是否有人知道IntelliJ IDEA中类似的Java工作插件？

我注意到GhostDoc在很长一段时间内没有更新.所以我很好奇是否有一个Resharper或CodeRush插件可以完成同样的事情？或者即使这种类型的功能内置于其中一个很棒的工具中.

我不想记录<value>C# 属性的元素。然而，GhostDoc 的配置正是为了做到这一点。我认为通过访问配置屏幕并删除元素很容易删除它。但是没有按钮或右键单击上下文菜单来执行此操作。按DEL在这里也不起作用。有什么建议或想法吗？