标签: comments

说服别人评论他们的代码有什么好的理由？

我注意到许多程序员喜欢编写代码的速度,而没有评论而是为自己和其他人留下一些文档.当我试图说服他们时,我会听到一半被烘焙的东西,比如"方法/班级名称应该说它做什么"等等.你会怎么说他们改变主意？

如果您反对评论,请发表评论.对于试图说服人们评论代码的人来说,这应该是一种资源,而不是其他.:-)

其他相关问题是:评论代码,您是否评论您的代码以及您希望如何评论.

当我试试这个

<option disabled = "disabled" <!-- Used to disable any particular option -->
        selected = "selected" <!-- Used to pre-select any particular option -->
        label = "string"      <!-- Used to provide a short version of the content in the option --> 
        value = "value">      <!-- The actual value that will be send to the server. If omitted the content between the option opening and closing tags will be send. -->

Option 1
</option>

我试图评论元素的openning标记内的属性和值.但是这不起作用,因为浏览器(在IE9,FF4.01,GG11,AF5和Opera11上测试)将禁用="禁用"之后的所有内容视为注释或内容.

元素的开头标记内是否不允许使用HTMl注释？

我需要使用JavaScript RegExp对象从JavaScript源中删除所有JavaScript注释.

我需要的是RegExp的模式.

到目前为止,我发现了这个:

compressed = compressed.replace(/\/\*.+?\*\/|\/\/.*(?=[\n\r])/g, '');

此模式适用于:

/* I'm a comment */

或者:

/*
 * I'm a comment aswell
*/

但似乎不适用于内联:

// I'm an inline comment

我不是RegEx的专家和它的模式,所以我需要帮助.

另外,我想要一个RegEx模式,它将删除所有那些类似HTML的注释.

<!-- HTML Comment //--> or <!-- HTML Comment -->

还有那些条件HTML注释,可以在各种JavaScript源中找到.

谢谢.

这主要是出于好奇心.我已经知道Xcode能够以形式识别评论// TODO: Something I don't feel like doing now.将该行添加到文件源将导致该TODO注释显示在Xcode的导航栏中:

我最近还发现表单的注释// MARK: Something可以达到与#pragma mark某些东西相同的效果.所以我可以写一个看起来像这样的评论:

// MARK: -
// MARK: Future Improvements:
// TODO: Make something better
// TODO: Fix some bug

Xcode会像这样呈现出来:

这让我想知道:Xcode可以理解其他类型的评论来改进项目导航吗？

我正在清理别人的代码并使用vim.我想重新发表评论,以便他们的格式一致.

例如:

    # one two three four five six seven
    # eight nine
    # ten eleven twelve thirteen fourteen
    # fifteen sixteen seventeen 
    # eighteen
    # nineteen

会成为:

    # one two three four five six seven eight nine ten eleven 
    # twelve thirteen fourteen fifteen sixteen seventeen
    # eighteen nineteen

因此,一个可以轻松取消注释代码的工作流,重新生成段落,然后在保留缩进的情况下重新注释代码.如果有一个现有的插件可以做到这一点,那就太好了.

在编辑,构建或从SQL语句中挑选时,我发现自己可以与四种流行的数据库工具之一进行交互.我一直在使用DB2和Informix的单行注释.我已经在vim中创建了宏来提高效率,但我想知道我是否工作太辛苦了.

我刚刚发布了这个问题并了解了<see cref="">,但是当我尝试的时候

/// This is a set of extensions that allow more operations on a <see cref="byte[]"/>.

编译器给了我关于它没有正确格式化的警告.我需要做什么才能正确看到代码引用？

是否有可能使Facebook的评论小部件流畅？他们的文档显示了fb:commentsxfbml或iframe 的宽度字段,其指定为:

• width - 插件的宽度(以像素为单位).建议的最小宽度:400px.

也许这不可能......

在Xcode中是否有一种方法可以自动生成方法注释,类似于您在Eclipse中为javadoc注释所做的操作.

例如,按下你可以在方法声明之前点击/**一行,eclipse会自动生成方法注释的骨架.

在Visual Studio 2010中,我有多行文本要注释:

A
B
C

使用Ctr + E + C注释掉多行,我明白了

//A
//B
//C

我喜欢在//和A之间有空格(或缩进),因此// A而不是//A.但是,在我对一个文本块进行分组并缩进后,Ctr + E + C不再注释掉所选文本.

如何分组评论并获得以下内容:

// A
// B
// C