问题标签 [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.

0 投票
7 回答
15609 浏览

c++ - 如何在启用 ANSI 的同时在 gcc 中启用 C++ 样式的注释?

这是我在哪里工作的一个问题,所以我做了一点挖掘,答案是 ExpertsExchange 一个。所以我把你交给最初的提问者,Manchung:

我有一个用纯 C 语言编写的项目,用于嵌入式系统。所以,我使用纯 C 来最小化代码大小。

当我编译项目时,我使用 -ansi 标志来确保代码符合 ANSI 标准。然而,使用这个 ansi 标志的缺点是我只能使用 C 风格的注释 (/*comments */)。当我需要使用嵌套注释时,这让我很头疼。

所以,我的问题是:我可以使用哪些开关/标志来允许我使用 C++ 样式的注释(// 注释),同时保持启用 ANSI 检查?

这也几乎总结了我的问题。

0 投票
28 回答
2601 浏览

comments - 已删除的注释代码

评论被删除的代码是一个好习惯吗?例如:

在同行评审期间,我的开发人员组中的某个人注意到我们应该评论要删除的代码行。我认为这是一个糟糕的建议,因为它用无用的注释使代码混乱。我们谁是对的?

0 投票
3 回答
607 浏览

c++ - 注释掉评论

我注意到,使用 Visual Studio 2003,我可以“注释掉”我的评论,使它们不再是评论。这需要一个例子:

如果我有:

我可以用 // 注释掉 /* 和 */ 并且 /* 和 */ 中的代码不再“注释掉”(文本变为非注释颜色编译器再次将其视为代码)。像这样:

我发现这对于 msvc 2003 是正确的,这是正常的 C++ 行为还是只是与此编译器一起工作的侥幸?

0 投票
2 回答
133 浏览

java - Java代码中的“持有属性值”

我得到了一些带有该标题的遗留代码,几乎在每个领域都以注释的形式展开。也出现了“ Setter for property xyz”。

只是出于好奇,哪个 Java 工具生成了这个存根?

0 投票
4 回答
4276 浏览

c# - C# 注释教程

我想知道哪一个是我可以分发给我的学生的关于“ C# 注释”的最佳材料。

0 投票
10 回答
5084 浏览

version-control - 版本控制注释的最佳实践

有很多关于评论代码的讨论,但是评论签入怎么样?

我发现这篇博文: http ://redbitbluebit.com/subversion-check-in-comment-great-practices/

作为整理发行说明的人,我正在寻找使这项工作更容易的方法。

<Begin_Doc>...<End_Doc>目前,我们为应该发布给我们的软件客户的任何内容定义了自己的方案。但即使是内部的东西,我也想知道每次更改的“原因”。

0 投票
13 回答
1476 浏览

c# - 关于关闭 {} 的 C# 注释

我一直在使用 DevExpress CodeRush 和 Refactor!本周 Pro,我选择了一个评论器插件,它会在你输入代码时自动生成评论。

我不想谈论它在挑选基本含义方面做得有多好(实际上非​​常好),但它的默认实现确实提出了一个问题。

默认情况下,键入 } 字符来关闭块将导致插件添加如下注释...

(即在打开它的右大括号标签中添加注释。)

虽然我可以看到在某些情况下这种行为可能很有用,但我觉得生成的代码看起来非常不整洁,加上所有额外的注释。

我想知道其他人对这种评论的看法是什么。不仅仅是从学术的角度来看,而且如果我收到大量关于他们的负面评论,我可以决定是将它们强加给我的同事还是将它们剔除。

0 投票
23 回答
53523 浏览

c# - 你如何标记代码,以便以后可以回来处理它?

在 C# 中,我使用#warningand#error指令,

这样,编译器会让我知道我还有工作要做。你用什么技术来标记代码,这样你就不会忘记它?

0 投票
6 回答
2018 浏览

delphi - Delphi Short Cut 添加日期和名称注释

有谁知道放置我的名字和光标所在日期的捷径,即

所以我在添加评论时不会一直检查日期。

我使用的是 Delphi7,安装了 CnPack 和 GExperts。我认为它应该能够与其中一位专家一起完成。

0 投票
1 回答
672 浏览

c++ - 在 Unix 环境下隐藏代码中的注释

我使用典型的 Unix 工具(emacs、vim、gvim、sunstudio 等)在 Unix 环境中工作

我的项目对每种方法都有大量的样板评论。它使文件长达数千行,实际代码只有几百行。我可能有点夸张,但你明白了。我正在寻找一种在查看这些文件时隐藏(而不是删除)所有评论的方法,以便我可以快速浏览代码。仅 C++ 注释 '//'。