Questions tagged «comments»

我在代码中看到了很多，甚至vim都将其标记为特例。#TODO和#FIXME另外两个固定标记Vim高亮但到底是什么#XXX意思？

126 comments 

您使用什么约定来评论获取方法和设置方法？这是我很长时间以来一直想知道的事情： /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) */ public float getSalary(); 我总是发现我几乎为1a / b和2a / b写了完全相同的东西，例如1a）设置员工的薪水，1b）员工的薪水。似乎太多余了。现在我可以看到对于更复杂的内容，您可以在（a）部分中编写更多内容，以提供具体背景信息，但是对于大多数使用方法的人来说，措辞几乎完全相同。 我只是好奇，对于简单的获取者/设置者而言，仅填写（a）部分还是（b）部分是否可以。 你怎么看？

124 java  comments  javadoc  setter  getter 

如何在Clojure中注释多行？

119 clojure  comments 

剃刀视图中服务器端注释的语法是什么？ 我想评论这段代码： /* @helper NavItem() { } */

116 asp.net-mvc-3  razor  comments 

只是一个简单的问题：我已经看到一些PHP函数在顶部使用了我不知道的格式进行注释： /** * * Convert an object to an array * * @param object $object The object to convert * @return array * */ 我的IDE为我提供了诸如@param和@return之类的下拉菜单，因此必须在某个地方进行记录。我已尝试搜索google，但搜索中不会包含@符号。 评论的格式是什么？在哪里可以找到一些信息？

115 php  function  comments  format  phpdoc 

在界面中添加Javadoc注释并在实现中添加非Javadoc注释是否正确？ 当您自动生成注释时，大多数IDE都会为实现生成非JavaDoc注释。具体方法不应该有描述吗？

109 java  interface  comments  javadoc 

我（有点）已经知道这个问题的答案。但是我认为这是R用户列表中经常被问到的问题，应该有一个可靠的好答案。 据我所知，R中没有多行注释功能。那么，有人有什么好的解决方法吗？ 尽管R中很多工作通常涉及交互式会话（这使人们对多行注释的需求产生怀疑），但有时我不得不将脚本发送给同事和同学，其中很多涉及不平凡的代码块。对于来自其他语言的人来说，这是一个很自然的问题。 过去我使用引号。由于字符串支持换行符，因此使用 " Here's my multiline comment. " a <- 10 rocknroll.lm <- lm(blah blah blah) ... 工作良好。有谁有更好的解决方案？

108 r  comments  r-faq 

在Java .properties文件中，我们可以使用进行单行注释#。 有什么方法可以做多行注释？

103 java  properties  comments 

我写了巨大的MS DOS批处理文件。要测试此批处理文件，我只需要执行一些行，并希望隐藏/注释剩余的行。 我有一些现有的注释行开头，::因此我不能再使用::了，因为它会打乱所有注释。 我怎么解决这个问题？

98 batch-file  comments  dos 

Ruby是否有禁止注释？ 如果没有，是否有一种有效的方法插入#TextMate中突出显示的代码块的前面？

97 ruby  keyboard-shortcuts  comments  text-editor 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 常识告诉我们，Doxygen注释块必须放在类，结构，枚举，函数，声明所在的头文件中。我同意这是一个合理的论据，对于没有源的库（仅包含目标代码的标头和库）来说，这是合理的。 但是...在开发公司内部（或作为我自己的副项目）库时，我一直在想完全相反的方法，该库将与其完整的源代码一起使用。我建议将大注释块放在实现文件（HPP，INL，CPP等）中，以免使标头中声明的类和函数的界面混乱。 优点： 头文件中的混乱程度较小，只能添加功能分类。 例如，使用Intellisense时预览的注释块不会冲突-这是我在.H文件中具有函数的注释块并在同一.H文件中具有内联定义时观察到的缺陷。但包含在.INL文件中。 缺点： （显而易见的一个）注释块不在声明所在的头文件中。 那么，您如何看待并可能提出建议？

97 documentation  comments  doxygen 

按照标题；是否可以在有效的HTML中嵌套注释？请参阅下面的示例... <p>some text</p> <!-- comment 1 <p>commented out html</p> <!-- comment 2 // are nested html comment allowed? end of comment 2 --> <p>more commented out html</p> end of comment 1 --> <p>some more text</p> 似乎没有，有人知道我如何才能使用嵌套注释吗？

96 html  validation  comments 

使用键盘快捷键注释或取消注释代码⌘+ 时，Xcode的可靠性非常不稳定/。我似乎找不到关于何时中断的真实模式，但通常会在模拟器上构建并运行代码后发生。在我编辑任何代码文件中的某些内容之前，它将不再起作用。即使我在主视图中切换到另一个文件，也无法通过快捷方式发表评论。其他键盘快捷键，例如缩进⌘+ [仍然可以正常使用。 其他人是否有此问题，如果是，您是否找到了解决方案？我知道这似乎是个小问题，但是在运行然后快速尝试注释掉一段代码以检查效果时，这带来了一些不便。 我在OXS Yosemite 10.10（14A389）上使用Xcode 6.1（6A1052d），并在iOS的Objective-C中进行开发。

94 xcode  comments  keyboard-shortcuts 

我使用Notepad ++作为编辑器来用Python编写程序。听起来有些愚蠢，但是我在编辑器中四处张望，找不到在我的代码中进行块注释的任何方法（不是手动方法，而是类似Emacs的方法）。 由于Notepad ++支持多种语言设置，因此我很想找到一种方法来阻止注释代码。

94 comments  notepad++ 

假设我有这个介面 public interface IFoo { ///<summary> /// Foo method ///</summary> void Foo(); ///<summary> /// Bar method ///</summary> void Bar(); ///<summary> /// Situation normal ///</summary> void Snafu(); } 而这个班 public class Foo : IFoo { public void Foo() { ... } public void Bar() { ... } public void Snafu() { …

93 c#  inheritance  comments