标签: comments

关于Python编码指南的文档,我在Python源文件中遇到了以下标题格式:

#!/usr/bin/env python

"""Foobar.py: Description of what foobar does."""

__author__      = "Barack Obama"
__copyright__   = "Copyright 2009, Planet Earth"

这是Python世界中标题的标题格式吗？我可以在标题中添加哪些其他字段/信息？Python专家分享您对优秀Python源头的指导:-)

您遇到的源代码中最好的评论是什么？

我有一个简单的package.json文件,我想添加一个评论.有办法做到这一点,还是有任何黑客可以使这项工作？

{
  "name": "My Project",
  "version": "0.0.1",
  "private": true,
  "dependencies": {
    "express": "3.x",
    "mongoose": "3.x"
  },
  "devDependencies" :  {
    "should": "*"
    /* "mocha": "*" not needed as should be globally installed */
  }
}

上面的示例注释不适用于npm中断.我也试过//风格评论.

我知道如何在Bash脚本中编写多行命令,但是如何在多行命令中为每一行添加注释？

CommandName InputFiles      \ # This is the comment for the 1st line
            --option1 arg1  \ # This is the comment for the 2nd line
            --option2 arg2    # This is the comment for the 3nd line

但不幸的是,继续角色之后的评论\将打破命令.

在Office(ALT+ F11)的VBA编辑器中,您如何评论或取消注释代码块？

我一直在编写一些批处理文件,并且我遇到了这个用户指南,该指南非常有用.它告诉我的一件事是线条不仅可以评论REM,还可以评论::.它说:

批处理代码中的注释可以使用双冒号进行,这比使用REM命令更好,因为标签在重定向符号之前处理.::<remark>没有问题但rem <remark>会产生错误.

为什么那么,我看到的大多数指南和示例都使用REM命令？是否::在所有版本的Windows工作？

我有一位同事坚持认为他的代码不需要评论,而是"自我记录".

我已经回顾了他的代码,虽然它比我见过其他代码生成的代码更清晰,但我仍然不同意自我编写代码是完整和有用的以及评论和记录的代码.

帮助我理解他的观点.

• 什么是自我记录代码
• 它真的可以取代评论和记录良好的代码
• 是否存在比记录良好和注释的代码更好的情况
• 是否存在代码无法在没有注释的情况下进行自我记录的示例

也许这只是我自己的局限,但我不知道它是如何成为一种好的做法.

这并不是一个争论 - 请不要提出为什么评论和记录良好的代码是高优先级的原因 - 有很多资源显示这一点,但它们并不能让我的同行相信.我相信我需要更充分地理解他的观点来说服他.如果必须,请开始一个新问题,但不要在此争论.

哇,快速反应!请阅读所有现有答案,并为答案提供评论,而不是添加新答案,除非您的答案与此处的其他答案完全不同.

此外,那些反对自我记录代码的人 - 这主要是为了帮助我理解自我记录代码福音传道者的观点(即积极方面).如果你不留下话题,我希望别人会贬低你.

如何在Vim的配置文件中添加注释,例如 .vimrc?

好的,我知道三引号字符串可以作为多行注释.例如,

"""Hello, I am a 
   multiline comment"""

和

'''Hello, I am a 
   multiline comment'''

但从技术上讲这些都是字符串,对吗？

我用谷歌搜索并阅读了Python风格指南,但我无法找到技术答案,为什么没有正式实现多行,/**/类型的评论.我使用三引号没有问题,但我对导致这个设计决定的原因有点好奇.

有没有办法在.ASPX页面中注释标记,以便它不会传递给客户端？我已经尝试了标准注释,<!-- -->但这只是作为注释发送,并不会阻止控件呈现.