标签: comments

我(有点)已经知道这个问题的答案了.但我认为这是一个在R用户列表中频繁询问的问题,应该有一个很好的答案. 据我所知,R中没有多行注释功能.那么,有没有人有任何好的解决方法？

虽然R中的相当多的工作通常涉及交互式会话(这使得对多行注释的需要产生怀疑),但有时我不得不向同事和同学发送脚本,其中大部分涉及非常重要的代码块.对于来自其他语言的人来说,这是一个相当自然的问题.

在过去,我使用了引号.由于字符串支持换行符,因此运行R脚本

"
Here's my multiline comment.

"
a <- 10
rocknroll.lm <- lm(blah blah blah)
 ...

工作良好.有没有人有更好的解决方案？

只是一个简单的问题:我已经看到一些PHP函数在顶部被注释,使用了我不知道的格式:

/**
 *
 * Convert an object to an array
 *
 * @param    object  $object The object to convert
 * @return      array
 *
 */

我的IDE为@param和@return之类的内容提供了一个下拉选项,因此必须在某处记录.我试过搜索谷歌,但它的搜索中不会包含@符号.

这种评论格式是什么？我在哪里可以找到相关信息？

在接口中添加Javadoc注释并在实现中添加非Javadoc注释是否正确？

当您自动生成注释时,大多数IDE会为实现生成非JavaDoc注释.具体方法不应该有描述吗？

Ruby有阻止评论吗？

如果没有,是否有一种有效的方法插入#TextMate中突出显示的代码块之前？

在Java .properties文件中,我们可以使用单行注释#.

我们有什么办法可以做多行评论吗？

常识告诉Doxygen注释块必须放在头文件中,其中包含类,结构,枚举,函数和声明.我同意这是一个合理的论据,这些库意味着在没有源的情况下进行分发(只有头和带有目标代码的库).

但是......当我正在开发一个公司内部(或者作为我自己的副项目)库时,我一直在考虑完全相反的方法,该库将与其完整的源代码一起使用.我建议将大的注释块放在实现文件(HPP,INL,CPP等)中,以免混乱标题中声明的类和函数的接口.

优点:

• 头文件中的杂乱性较小,只能添加功能分类.
• 使用Intellisense时预览的注释块不会发生冲突 - 这是我在.H文件中有一个函数的注释块并在同一.H文件中使用其内联定义时观察到的一个缺陷但包含在.INL文件中.

缺点:

• (显而易见的一个)注释块不在声明所在的头文件中.

那么,您的想法和建议是什么？

根据标题; 是否可以在有效的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>

看来不是,有人知道如何让嵌套注释工作吗？

当使用键盘快捷键注释或取消注释代码⌘+ 时,我遇到Xcode问题非常不可靠/.我似乎无法找到关于何时中断的真实模式,但它通常发生在模拟器上构建和运行我的代码之后.在我编辑任何一个代码文件中的内容之前,它将无法再次运行.即使我切换到主视图中的另一个文件,通过快捷方式进行注释也不起作用.其他键盘快捷键,如缩进⌘+ [继续工作就好了.

其他人是否有这个问题,如果有,你找到了解决方案吗？我知道这似乎是一个小小的抱怨,但在运行时,然后快速尝试注释掉一段代码来检查效果,这有点不方便.

我在OXS Yosemite 10.10(14A389)上使用Xcode 6.1(6A1052d),如果重要的话,在iOS的Objective-C中进行开发.

Java类通常分为逻辑"块".是否有标记这些部分的约定？理想情况下,它将受到主要IDE的支持.

我个人使用这种方法:

//// Section name here ////

但是,一些编辑似乎对此有疑问.

例如,在Objective-C代码中,您可以使用此方法:

#pragma mark -
#pragma mark Section name here

这将导致XCode中的菜单如下所示:

我找到了这个旧线程(来自一年多以前),它解释了R如何不支持多行注释(例如PHP的/*comment*/).

我想知道过去一年是否已经解决了这个问题,还是有其他选择？(例如,在带有npptor的notepad ++中,你可以标记一堆行并按ctrl + q将它们全部标记为注释,是否有其他IDE的类似解决方案？)