Questions tagged «comments»

我一直在编写一些批处理文件，并且遇到了本用户指南，该指南非常有用。它向我展示的一件事是，不仅可以用REM，也有::。它说： 可以使用双冒号在批处理代码中进行注释，这比使用REM命令更好，因为标签是在重定向符号之前处理的。::<remark>不会造成任何问题，但rem <remark>会产生错误。 那么，为什么我看到的大多数指南和示例都使用该REM命令？是否::在所有版本的Windows的工作？

283 batch-file  coding-style  comments 

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

276 vim  comments  configuration-files 

按照目前的情况，这个问题不适合我们的问答形式。我们希望答案会得到事实，参考或专业知识的支持，但是这个问题可能会引起辩论，争论，民意测验或进一步的讨论。如果您认为此问题可以解决并且可以重新提出，请访问帮助中心以获取指导。 7年前关闭。 我有一个同事坚持认为他的代码不需要注释，而是“自我记录”。 我已经阅读了他的代码，尽管它比我看到的其他代码更清晰，但我仍然不同意自我记录代码与注释和记录代码一样完整和有用。 帮我理解他的观点。 什么是自我记录代码 它真的可以代替经过良好注释和记录的代码吗？ 在某些情况下，它比记录和注释好的代码更好吗？ 是否有一些示例，其中如果没有注释，代码可能无法自我记录 也许这只是我自己的局限性，但我不认为这是一种好的做法。 这并不意味着要争论-请不要提出充分注释和记录的代码具有较高优先级的原因-有很多资源可以证明这一点，但它们并不能说服我的同事。我相信我需要更充分地了解他的观点，才能说服他。如有必要，请提出一个新问题，但不要在这里争论。 哇，反应快！请阅读所有现有答案，并为答案提供评论，而不要添加新答案，除非您的答案与此处的其他答案确实有很大不同。 另外，你们中那些反对自我记录代码的人-这主要是为了帮助我理解自我记录代码传播者的观点（即积极方面）。如果您不关注主题，我希望其他人会投票反对您。

258 documentation  comments 

好的，我知道三引号字符串可以用作多行注释。例如， """Hello, I am a multiline comment""" 和 '''Hello, I am a multiline comment''' 但是从技术上讲，这些是字符串，对吗？ 我已经在Google上搜索并阅读了Python样式指南，但是无法找到关于为什么没有正式实现多行，/ * * /注释类型的技术答案。我使用三重引号没有问题，但是我对导致这个设计决定的原因有点好奇。

252 python  comments  multiline 

我最近开始研究Shell脚本，并且希望能够注释掉Shell脚本中的几行内容。我的意思是在C / Java的情况下： /* comment1 comment2 comment3 */` 我该怎么办？

224 shell  comments  multiline 

有没有一种方法可以注释掉.ASPX页面中的标记，以便不将其传递给客户端？我已经尝试过标准注释，<!-- -->但这只是作为注释提供，不会阻止控件呈现。

208 asp.net  markup  comments 

是否有任何官方方式允许CSV格式的文件在其自己的行或行的末尾包含注释？ 我尝试在Wikipedia以及RFC 4180上进行检查，但是两者均未提及任何内容，这使我相信它不是文件格式的一部分，所以这对我来说是很不幸的事，因此我应该使用单独的ReadMe.txt文件来解释文件。 最后，我知道添加自己的注释很容易，但是我希望像Excel这样的东西可以直接将其导入，而无需消费者必须自定义导入过程。 那么，有什么想法吗？

203 csv  comments  standards  file-format 

之间有什么区别 /** * comment * * */ 和 /* * * comment * */ 在Java中？我什么时候应该使用它们？

190 java  comments  javadoc 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使它成为Stack Overflow 的主题。 2年前关闭。 改善这个问题 一个Xcode中5的新功能是一种特殊的注释语法来记录自己的代码的能力。格式类似于doxygen，但似乎仅支持这些功能的子集。 支持哪些命令，不支持哪些命令？ 它们的用法是否与doxygen不同？

186 objective-c  documentation  comments  doxygen  xcode5 

Eclipse是否具有热键来注释一个块？并取消注释？

185 eclipse  comments  hotkeys 

向下看这个build.gradle文件 apply plugin: 'com.android.application' android { compileSdkVersion 21 buildToolsVersion "21.1.2" defaultConfig { applicationId "package.myapp" minSdkVersion 19 targetSdkVersion 21 versionCode 1 versionName "1.0" } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } } dependencies { compile fileTree(dir: 'libs', include: ['*.jar']) compile 'com.nineoldandroids:library:2.4.0' } 如果我想什么写评论我为什么选择这个库为这个项目， 在build.gradle文件中写注释的语法是什么？

178 android  gradle  comments  android-gradle-plugin  build.gradle 

Jenkinsfile中可能有注释吗？如果是这样，语法是什么？ 我正在使用声明性管道语法。 我要注释掉下面的“发布”部分，直到我的SMTP服务器正常工作为止。 pipeline { agent { label 'docker-build-slave' } environment { IMAGE = 'registry.gitlab.com/XXXXX/bible-server' DOCKER_REGISTRY_CREDENTIALS = credentials('DOCKER_REGISTRY_CREDENTIALS') } options { timeout(10) } stages { stage('Test') { steps { sh 'yarn' sh 'npm test' } } stage('Build') { when { branch '*/master' } steps { sh 'docker login -u ${DOCKER_REGISTRY_CREDENTIALS_USR} …

177 jenkins  groovy  comments  jenkins-pipeline 

TypeScript注释的语法是否记录在任何地方？ 并有机会现在支持C＃///系统吗？

165 comments  typescript 

如何在脚本中对以下各行的每一行进行注释？ cat ${MYSQLDUMP} | \ sed '1d' | \ tr ",;" "\n" | \ sed -e 's/[asbi]:[0-9]*[:]*//g' -e '/^[{}]/d' -e 's/""//g' -e '/^"{/d' | \ sed -n -e '/^"/p' -e '/^print_value$/,/^option_id$/p' | \ sed -e '/^option_id/d' -e '/^print_value/d' -e 's/^"\(.*\)"$/\1/' | \ tr "\n" "," | \ sed -e 's/,\([0-9]*-[0-9]*-[0-9]*\)/\n\1/g' …

164 bash  syntax  comments 

在搜索Python项目时，我发现有几行用注释# noqa。 import sys sys.path.append(r'C:\dev') import some_module # noqa noqa在Python 中是什么意思？它仅适用于Python吗？

162 python  comments  terminology  code-analysis  pep8