问题标签 [ghostdoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
40 浏览

c# - 添加登录到 GhostDoc 生成的帮助网站

我有一个项目,所有的 XML 注释都设置好了,文档正在按预期生成,但我的老板想把文档本身放在登录后面,这样它就不能自由访问了。

我可以通过添加登录页面并在 IIS 中进行设置来做到这一点吗?或者,我是否必须在每个单独的页面上添加一些内容以强制它确保有人已登录并有权查看文档?或其他?

0 投票
1 回答
58 浏览

c# - GhostDoc Context.CurrentCodeElement.HasBaseTypes 始终返回 false

关于如何使用 Ghost Doc 获取类的基本类型的任何想法?

根据当前类继承的基类,我想自定义当前类的摘要注释。

这是我到目前为止所拥有的:

0 投票
1 回答
63 浏览

c# - Ghostdoc 无法正确处理带下划线的大写常量

const当遇到包含下划线的 a 时, Ghostdoc 似乎会感到非常困惑。撇开常量是否应该采用这种格式不谈,在我看来,这可以更好地处理。我在下面提供了一个示例:

在此处输入图像描述

除了重构所有常量之外,有没有办法强制 Ghostdoc 处理这些?我没有看到任何似乎符合选项的内容。

我在版本 5.1.16036 上。

0 投票
1 回答
106 浏览

sandcastle - 处理 MSDN 样式帮助文件的 xml 文档代码注释中的自定义 xml 元素

我正在寻找一种方法来构建包含大型项目的自定义 XML 元素的帮助文件。我想添加我自己的类似于 Summary 元素的元素,并让帮助文件包含它。我安装了 Sandcastle 和 Ghost Doc Pro。我一直无法找到让这些帮助文件构建器中的任何一个包含我的自定义标签的方法。一个例子:

如果有人可以让我引导我找到文档以将自定义元素包含在文档中,那就太好了。

0 投票
0 回答
343 浏览

c# - 如何自定义 GhostDoc Pro 的文档模板?

我不喜欢 GhostDoc 的标准XML 样式文档,并且希望将其更改为更符合JavaDoc或至少更改为 Visual Studio 在 C# 中添加注释的标准方式(如果您键入)///

所以要么:

或者:

0 投票
1 回答
2949 浏览

visual-studio - GhostDoc Free 做了哪些 Visual Studio 还没有做的事情?

我正在尝试找到一种方法将我在 Visual Studio 中生成的评论///转换为 HTML。看来GhostDoc Pro会为我做这件事。GhostDoc Free 所做的就是在 Visual Studio 中生成注释。

从他们的网站上我可以看出,GhostDoc Free 所做的只是生成与您在 Visual Studio 中可以执行的完全相同的注释。唯一的区别是Ctrl Shift D反对///

我怀疑这样一个流行的 Visual Studio 免费扩展只能做 Visual Studio 已经做的事情,而且我只是误解了他们的网站。那么除了做 Visual Studio 已经做的事情之外,GhostDoc Free 还做了什么?

我正在尝试确定是否需要 Pro 版本来外部化我的文档,但我也很好奇免费版本是否真的有任何作用。

0 投票
1 回答
48 浏览

documentation - 如何仅使用 GhostDoc 记录子文件夹?

我正在尝试在 GhostDoc 中构建帮助文件。它只让我可以选择记录整个项目。我只想记录项目中的子文件夹。我怎样才能做到这一点?

在此处输入图像描述

我看不到选择子文件夹的选项。如果我右键单击一个项目,则不会出现任何选项。有谁知道如何只记录一个子文件夹?

0 投票
0 回答
45 浏览

visual-studio-2015 - VS2015 在一个特定的键盘快捷键中失败

我正在使用安装了 GhostDoc 5.1 的 VS 2015 版本 14.0.25425.01 更新 3。

我使用 Ctrl+Shift+D 来记录属性或方法,这在一周左右之前一直很好用(我不知道这是否与 SSMS 2016 的最新更新有关)。

自上周打开我的机器以来,一切正常,但过了一会儿快捷方式停止工作(如果我将操作更改为另一个快捷方式,它工作正常),使其再次工作的唯一方法是重新启动机器(再次分配它,关闭所有 VS 实例不起作用)。

我导出了我的键盘设置,看看是否有什么东西在使用它,我唯一发现的是 SSMS 的设置:

但是在 SSMS 的键盘设置中,该操作没有关联的快捷方式。

有没有办法让我知道发生了什么?VS的ActivityLog没有显示任何明显的东西,GhostDoc的日志也没有

PS:有没有办法禁用新的文档维护工具栏?

0 投票
1 回答
388 浏览

c# - 我能得到一份关于缺少 XML 文档的报告吗

我正在尝试 GhostDoc、StyleCop、CodeIt.Right、FXCop 等,以找到一种在 C# 代码中添加自动生成的 XML 注释以及更新现有注释以防例如参数更改的简化方法。

GhostDoc Pro 似乎运行良好,除了我无法获得有关覆盖率的报告,或者至少无法获得完全缺乏文档的类。

我怎样才能得到这样的报告?

0 投票
1 回答
83 浏览

ghostdoc - Ghostdoc 创建一个帮助文件夹,但没有 .chm 文件

我已经安装了 Ghostdoc 企业版和 Visual Studio 2017 扩展。我已经安装了 htmlhelp。每次我通过 cmd 或通过 Visual Studio 本身构建帮助文档时,都会创建一个帮助文件夹,但该文件夹是空的,而应该有一个 .chm 文件。似乎没有错误,只有“No APIs found to document”

任何人都可以帮我解决这个问题或指出我可以得到帮助的方向吗