问题标签 [remarks]

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 回答
2898 浏览

compiler-construction - 如何禁用英特尔编译器编写的“LOOP WAS VECTORIZED”注释?

我想禁用英特尔编译器编写的“LOOP WAS VECTORIZED”注释。但我不想禁用优化。我需要做什么?

0 投票
1 回答
866 浏览

comments - xcopy 排除文件中的注释或备注

我知道 xcopy 是如何工作的,但是可以在排除文件中添加注释吗?像这样的东西:

0 投票
2 回答
5194 浏览

visual-studio-2010 - 如何让 Visual Studio 智能感知显示 XML 注释的备注部分?

输入代码时,我非常喜欢 Visual Studio 2010 (Professional) 的智能感知功能,尤其是我能够查找正在使用的类型的 XML 注释。(请参阅Microsoft 的文档)。到目前为止,这有效。但是,XML 代码注释的备注部分不显示。

我认为这是一个非常有用的功能,因为通常有一些有用的信息无法从摘要中轻易猜出。(这就是为什么我们有一个评论部分,我猜)

如何在智能感知级别探索 Visual Studio 2010 (Professional) 中的备注部分?(我使用DevXpress Coderush,如果这很重要,但我不这么认为)。

0 投票
1 回答
193 浏览

html - 如何将多个备注分组到一个段落中?

我对 doxygen 比较陌生,我更喜欢 Javadocs(当我编写更多 Java 时)和常规文字处理工具(当我为 IBM 工作时)。

我的评论风格是在整个代码库中穿插大量运行叙述,以便代码的目的非常明确。我更愿意重新处理该文本,以便将其用于我正在生成的 API 的外部文档。

当我使用 \remark 标记时,我最终将每个 \remark 作为 HTML 输出中的一个单独段落。这看起来不像我想要的样子。我也不希望有一个可能涵盖 6 或 8 个代码块的巨大 \remark。

我的问题是——我如何告诉 doxygen 将多个 \remark 部分“合并”成一个段落,只有在我想要的时候才开始一个新段落?

0 投票
0 回答
153 浏览

c# - 如何设置 pscmdlet 类的帮助信息

我正在用 c# 编写一个 powershell 模块,它由一堆 powershell cmdlet 组成。

例如:

获取应用程序

当我宣布班级时

我可以做一些事情,例如为此 cmdlet 提供参数以及有关参数本身的有用消息。

我正在尝试在我的课程中提供更多文档,以便像这样的命令

获取帮助获取应用程序

将在 REMARKS 部分提供有关 cmdlet 本身的描述。

知道如何在 Visual Studio 2013 中添加它吗?

0 投票
1 回答
221 浏览

html - 如何让 vim 在同一个文件上使用 html 和 markdown 语法高亮显示?

我使用remark从 vim 中的 markdown 代码制作 html 幻灯片。

Remark 需要使用包含 html 和 markdown 代码的html 模板。

如何让 vim 在同一个 html 文件上同时使用 html 和 markdown 语法高亮显示?

0 投票
3 回答
939 浏览

soap - 交叉或洛林和 AddRemarkLLSRQ?

使用 SOAP API 如何使用 AddRemarkLLSRQ 将 cross 或 lorraine 写入备注?

我曾尝试使用 ascii 代码,但没有运气

请求是

回应是

0 投票
1 回答
117 浏览

vb.net - vb.net:如何评论继续声明

我在互联网上搜索,但找不到解决问题的方法:我将一组参数传递给 Sub,其中一些参数是可选的,即我将位置留空。为了使代码可读并稍后了解我遗漏的内容,我想在那里发表评论。我只是找不到任何方法来做到这一点。

这是一个例子:

参数 PackEinheit 是可选的并且留空,但后来我想知道这个特定的参数被遗漏了。无论我将注释放在续行下划线的左侧还是右侧,我使用的语法都会产生错误。

有任何想法吗?

0 投票
1 回答
1829 浏览

c# - StyleCop SA1650 在没有警告抑制的情况下将 URL 捕获为拼写错误的单词的解决方法

我正在尝试在我的备注中包含一个 URL,如下例所示。这会导致 StyleCop 报告基于规则 SA1650 的警告(备注中拼写错误的单词),出于我们的目的,不能(通过策略)抑制该警告。这个警告并不奇怪,因为 URL 语法不需要正确的英文拼写。

首先,在摘要/备注中包含 URL 是否被认为是不好的做法?我猜不会,因为 Visual Studio 可以识别链接并使它们可点击。如有必要,我会删除它,但我想将参考留给其他人。

如果这被认为是不好的做法,有没有办法让 StyleCop 忽略 URL 文本而不抑制警告(或将整个 URL 或它的每个部分添加到识别的单词列表中)?我尝试了以下方法(URL 行上有四个正斜杠),但这会导致来自规则 SA1644 的警告(文档标题中不允许出现空行):

我目前的解决方案是使用comment-in-comment标签,如下所示,它不会产生任何警告,但我不知道这是否是最佳实践:

帮助我更好地记录我的代码。

0 投票
0 回答
271 浏览

sql-server - Schemacrawler 表/列注释/备注 SQL Server

我正在使用 SQL Server 数据库,我INFORMATION_SCHEMA不包含TABLECOLUMN评论,我想将这些添加到生成的输出中。

到目前为止,我已经能够使用查询的自定义查询生成 html sys.extended_properties,但这意味着我无法生成像 svg 这样的东西。

有没有办法让 schemacrawler 使用其中的信息sys.extended_properties并仍然使用可用的生成方法?