code-documentation

    0热度

    2回答

    我们已经在c#.net中开发了一个应用程序,并且旨在使其可以在我们的Intranet中部署。我们希望有一个可靠的文件来配合它,但不确定记录这一点的最佳平台。有哪些工具可以促进这一过程? 我发现了关于Doxygen,Htmlhelp或Dr Explain,但我仍然不确定要使用什么。

    0热度

    2回答

    嗨,大家好:有没有一种方法可以提高trac wiki的质量:使用插件来处理过时页面之类的工件,或者引用不再存在的代码的页面,不连接的页面或者页面低的页面更新率?我觉得可能是几个启发式这可以用来防止维基腐: 最近编辑数 最近的一些看法 阉或不是一个网页链接到源文件 用是否维基页面的最后更新是<或>源代码文件它链接到维基 阉整个目录已使用/编辑/忽略过去的“n”天 等等等等。 如果没有别的,只是从管理

    0热度

    3回答

    我正在看http://www.phpdoc.org/,但想知道你们认为有用。我想要一些能够帮助记录我们的代码的东西,还需要在网站上经常执行的程序和任务。在linux/PHP/MySQL环境中,这是最好的解决方案是什么?

    -2热度

    2回答

    更改UILabel的颜色的语法是什么? 此外,在哪里可以找到这些信息?

    148热度

    4回答

    我知道这不是最重要的问题,但我意识到我可以在注释之前或之后放置javadoc注释块。我们希望采用什么作为编码标准? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a java

    2热度

    3回答

    这是我写的一个班级模板。它有两个公共功能(三个如果你计算Instance();它是一个单身人士)和四个私人功能。代码不太重要;我想问问你是否认为我的文档评论过于明确。 我试图记录当输入错误等情况时会发生什么,并且准确地说明了所有内容,但是我见过的其他库没有这样的显式文档—我是否过度使用它? /** \class ResourceManager \details Singlet

    6热度

    4回答

    我们向外部客户提供了大量程序集,但并非所有的公共API都得到官方支持。例如,由于不太理想的设计选择,有时候一个类型必须公开地从程序集公开暴露出来,以使其余代码能够工作,但我们不希望客户使用该类型。沟通缺乏支持的一部分不能以XML注释的形式提供任何智能感知。 有没有办法选择性地禁止XML注释?因为这是一个长期的维护问题,所以我正在寻找其他方法,而不是忽略警告1591。 示例:我有一个包含公共类A和B

    0热度

    1回答

    我已经写了一个相当简单的类的文档,但我觉得它不够清楚。我应该改变什么吗? /** Pointer class that wraps resources loaded through the ResourceManager. The manager is notified to increase or decrease the reference count of a

    35热度

    8回答

    我正在浏览一些我刚刚写的代码,并将NDoc sytle注释添加到我的类和方法中。我希望能够生成一个非常好的MSDN样式文档以供参考。 一般来说,在为一个班级和一个方法写评论时,有什么好的指导方针? NDoc评论应该说什么?他们不应该说什么? 我发现自己在看.NET框架评论说些什么,但变老快;如果我能有一些很好的规则来指导自己,我可以更快地完成文档。

    8热度

    2回答

    我们将ReSharper 6.0与StyleCop一起用于ReSharper。 虽然我们使用的成员必须具有文件头的规则StyleCop的,我们不希望ReSharper的代码清理工具来生成文档标题为我们,因为他们是不可避免的垃圾。糟糕的文档头比没有更糟糕,因为它们不太可能被更新,而不是首先被添加。 我们尝试在ReSharper => Options => Tools => StyleCop中关闭设置