标签: comments

我正在尝试使用JSDoc-toolkit记录我的代码.我的代码首先包含一个自执行的匿名函数.我怎么在世界上记录这个？我几乎整天都在这上面.JS Docs不会识别匿名函数闭包内部的任何内容,因为它不知道如何处理它.它打破了,我的评论都没有通过.

我的代码看起来像这样.

/** 
 * @fileoverview BLA BLA BLA
 */

/**
 * This is where I don't know what to put.
 */
 (function () {
     "use strict";

     /** or here */
     var stlib = function (param, param, param) {
         /** or here */
         var share = {
             /** or here */
             config: {
                 button: DOM Element,
                 property: blablabla
             },

             init: function () { ...some init code here}
         };

         share.init();
     };

     widgets.add("share", stlib);
 }());

谢谢!

在JetBrains IntelliJ IDEA中,我想编辑评论

/**
 * Created by IntelliJ IDEA.<br/>
 * User: ${USER}<br/>
 * Date: ${DATE}<br/>
 * Time: ${TIME}<br/>
 * To change this template use File | Settings | File Templates.
 */

并为类型生成注释

public class MyUsernamePasswordAuthenticationFilter extends UsernamePasswordAuthenticationFilter

或类似的功能

protected  void checkUsbKeyID(UserObj user,String usbKeyID)

Java编程语言中的公认实践是结束带有注释的代码块的括号,该注释简要说明了括号关闭的代码块？我个人认为它们是无用的评论,这些评论会破坏代码的可读性,但也许我可能是错的.例如:

public void myMethod(int foo) {    
    // some code
    if (foo == 2) {
        for (int i = 0; i < myMax; i++) {
            while (true) {
                // some more code
            } // end while
        } // end for
    } // end if
} // end myMethod(int)

以类似方式评论代码块的做法是否被接受？

我经常在Vim中同时评论几行,这种情况经常发生.我所知道的方法并不像TextMate那样快速地评论行.

你最喜欢的方式是什么？

我目前使用:

方法1:

• 转到第一行的char并使用blockwise visual mode(ctrl- v)
• 向下/向上,直到选择要注释掉的每一行的第一个字符
• 使用shift- i然后输入你的评论字符(#对于Ruby)
• 用于esc将注释字符插入每一行

方法2:

• 使用线性可视模式选择需要注释掉的行(shift- v)
• 类型:,它提供了一个:'<,'>可以扩展到的提示:'<,'>s/^/#/

方法3:

• 转到要注释的第一行
• 制作书签,例如打字 mm
• 转到要注释掉的最后一行
• 类型 :'m,.s/^/#/

我最喜欢方法1,但我仍然希望有更好的方法.

如何更改~/.vimrc以使我的代码中的注释为斜体？

在我的~/.vimrc档案中,我有:

highlight Comment ctermfg=blue

这使评论变成蓝色.我需要做些什么才能使它们变成斜体？

使用PHP对.ini文件使用内联注释是否可行且安全？

我更喜欢一个系统,其中注释与变量一致,在它们之后.

是否有一些关于语法的问题？

这个RFC提到了

与许多编程语言不同,Perl目前没有实现真正的多行注释.这和常用的变通方法可能会有问题.这可以通过添加新语法来解决,以允许注释跨越多行,例如下面引用的文档中的变体.

有哪些常见的解决方法？

我在这里找到的两种技术是

if (0) {
  <comment>
}

和

=pod
<comment>
=cut

这些可以安全使用吗？还有其他更好的工作吗？

我使用VIM/GVIM来开发我的python项目,我随机地将#TODO注释留在我的代码中.

有没有办法管理(搜索,列出和链接)VIM内的所有#TODO事件？我尝试了tasklist插件,它几乎是我需要的,但它只列出了当前文件#TODO的出现次数.通常我的项目有一些子文件夹和许多.py文件,所以我想找到一种方法来搜索当前工作目录中的所有文件夹和文件并列出它们.

可能重复:
我可以评论JSON文件吗？

我们正在.json项目中使用文件.我们想知道是否可以向文件添加注释并避免崩溃JSON解析器.

我们尝试使用以下注释类型执行此操作,但它们在解析时都会使JSON文件崩溃:

# I crash
// I crash
/* I crash */

是否有可接受的评论JSON文件？

我对python中docstrings和comments之间的区别感到有点困惑.

在我的课堂上,我的老师介绍了一种被称为"设计方法"的东西,这一系列步骤可以帮助我们学生在Python中更好地绘制和组织编码.根据我的理解,下面是我们遵循的步骤示例 - 这就是呼叫设计配方(引文中的内容):

def term_work_mark(a0_mark, a1_mark, a2_mark, ex_mark, midterm_mark):

    ''' (float, float, float, float, float) -> float

    Takes your marks on a0_mark, a1_mark, a2_mark, ex_mark and midterm_mark, 
    calculates their respective weight contributions and sums these 
    contributions to deliver your overall term mark out of a maximum of 55 (This
    is because the exam mark is not taken account of in this function)

    >>>term_work_mark(5, 5, 5, 5, 5)
    11.8
    >>>term_work_mark(0, 0, 0, 0, 0)
    0.0
    '''

    a0_component = contribution(a0_mark, a0_max_mark, …