问题标签 [comments]
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.
html - HTML 注释分解
我有一个生成的页面,它在页面顶部附近插入了一个 HTML 注释。注释里面是一个 *nix 风格的命令。
此评论完全打破了页面。导致这种情况发生的评论有什么问题,为什么会这样?
pdf - 使用 PDF 阅读器评论 LaTeX PDF 文档
我目前正在用乳胶和 TexnicCenter 写我的学士论文。我希望能够将我生成的 pdf 文件发送给人们,他们应该能够写评论。默认情况下似乎不允许评论,我该如何更改?
我正在使用带有 pdflatex 和 acrobat reader 9 的直接 PDF 来阅读和评论文件
java - Java 多行注释是否考虑字符串?
这个问题可能同样适用于其他具有类似 C 的多行注释的语言。这是我遇到的问题。我在 Eclipse 中使用 Java 代码,我想注释掉一段代码。但是,有一个字符串包含字符序列“*/”,Eclipse 认为注释应该到此结束,即使它在字符串中。它给了我很多错误并且无法构建。
Java 规范是否与 Eclipse 对我的多行注释的解释相匹配?我想认为 Java 和/或 Eclipse 会解决这类问题。
c# - 是否有用于注释 C# 代码的标准(如 phpdoc 或 python 的文档字符串)?
是否有用于注释 C# 代码的标准约定(如 phpdoc 或 python 的文档字符串),以便可以从源代码自动生成类文档?
rss - 以编程方式确定博客文章有多少评论
确定特定博客帖子有多少评论的最有效方法是什么?我们想为一个新的网络应用程序存储数据。我们有一个永久链接 URL 和 RSS 提要的列表。
xml - XML 注释可以去任何地方吗?
我编写了一个简单的工具来使用用户输入的查询生成 DBUnit XML 数据集。我想将在 XML 中输入的每个查询作为注释包含在内,但是用于生成 XML 文件的 DBUnit API 不支持在我想要的位置(在它生成的数据之上)插入注释,所以我求助于将使用顶部或底部的所有查询进行评论。
所以我的问题是:将它放在任何一个位置都是有效的 XML 吗?例如,上面的 XML 声明:
或者在根节点下面:
我计划最初尝试高于 XML 声明,但我怀疑这是否是有效的 XML,尽管来自wikipedia的声明:
如果元素的内容是文本或#PCDATA,注释可以放置在树中的任何位置,包括文本中。
如果这可行,我计划回帖,但很高兴知道它是否是官方 XML 标准。
更新:有关我的测试结果,请参阅下面的回复。
language-agnostic - api 文档和“价值限制”:它们匹配吗?
您是否经常在 API 文档(例如“公共函数的 javadoc”)中看到“值限制”的描述以及经典文档?
注意:我不是在谈论代码中的注释
通过“价值限制”,我的意思是:
- 参数是否可以支持空值(或空字符串,或...)?
- '返回值'可以为空还是保证永远不会为空(或者可以是“空”,或者......)?
样本:
我经常看到的(无法访问源代码)是:
我希望看到的是:
我的观点是:
当我使用带有 getReaderNames() 函数的库时,我通常甚至不需要阅读 API 文档来猜测它的作用。但我需要确定如何使用它。
当我想使用这个函数时,我唯一关心的是:在参数和返回值方面我应该期待什么?这就是我安全设置参数和安全测试返回值所需要知道的全部内容,但我几乎从未在 API 文档中看到此类信息......
编辑:
这可能会影响已检查或未检查异常的使用或不使用。
你怎么看 ?值限制和 API,它们是否属于一起?
vb.net - VS2005 VB.NET XML 注释''' - 停止工作
我在不同项目中混合使用 VB 和 C# 的解决方案中使用 VS2005。
我在几台不同的计算机上使用此解决方案,并且带有 /// (c#) 和 ''' (VB) 的 XML 注释已经好几个月了。
突然之间,在我的主要开发机器上,他们已经停止在 VB 中工作。他们仍然在 C# 中工作。
他们也在其他项目中工作(在 VB 中)。这只是这一解决方案中的所有 VB 项目。
有没有人有任何想法?
我无法确定它何时停止工作,因为我已经数周/数月没有修改很多 VB 代码。
twitter - 如何让我的 Twitter 提要与博客集成(带有单独的评论线程)?
我想创建一个博客,我的 Twitter 更新基本上是创建带有评论线程的博客帖子。如果现在没有博客软件可以做到这一点(我做了一些搜索,但找不到评论方面),那么最简单的方法是什么并启动博客软件来做到这一点?
一种可能的替代方法是博客界面,它可以使用标题文本自动更新我的 Twitter 提要。
不管是什么解决方案,我都希望它是完全自动化的,这样它基本上不会比目前使用 Twitter Web 界面更新我的 Twitter 提要更多的工作。注意:我也对通过默认博客 Web 管理界面进行“正常”博客发布感兴趣。