Tag: 评论

#XXX是什么意思？: 我已经看到了很多代码，甚至vim标志着这是一个特例。 #TODO和#FIXME是两个其他固定标记vim高亮，但是#XXX是什么意思？

在Notepad ++中评论代码: 我使用Notepad ++作为编辑器来编写Python程序。这可能听起来很愚蠢，但是我在编辑器中四处张望，找不到任何方法（不是手动方式，而是像Emacs中的那样）在我的代码中执行块注释。由于Notepad ++支持如此多的语言设置，所以我很想find一种方法来阻止评论代码。

何处放置内部库的doxygen注释块 – 在H中还是在CPP文件中？: 常识告诉Doxygen注释块必须放在类，结构体，枚举，函数，声明所在的头文件中。我同意，这是一个很好的参数，意思是没有它的源代码的分发（只有头文件和库和目标代码）。但是…当我正在开发公司内部（或作为自己的一个项目）库时，我一直在考虑完全相反的方法，它将被用于完整的源代码。我所build议的是在实现文件（HPP，INL，CPP等）中放置大的注释块，以避免混乱头中声明的类和函数的接口。优点：在头文件中更less的混乱，只能添加function的分类。例如使用Intellisense时预览的注释块不会发生冲突 – 这是我在.H文件中为函数注释块时观察到的缺陷，并且其内联定义位于相同的.H文件中但是包含在.INL文件中。缺点：（显而易见的）注释块不在声明的头文件中。那么，你觉得和可能build议什么？

无法评论select: 有时候，我似乎无法用Xcode 8 Beta 4下的常用快捷方式（ command + / ）来评论我的代码。该选项在菜单中被禁用（截图如下）。你知道为什么吗？我是唯一有这个问题的人吗？编辑：它似乎重新启动Xcode后再次工作…仍然看它从哪里来。这有点烦人编辑2：它仍然发生在Xcode 8.1上。也许是因为我有2个版本的Xcode安装（正常和testing版）？不能用一个简单的重新启动修复它！编辑3：build议的xpccachectl命令来修复它不存在MacOS高塞拉利昂。

多行注释变通办法？: 我（有点）已经知道这个问题的答案。但我觉得这是在R用户名单上被频繁询问的问题，应该有一个很好的答案。据我所知，在R中没有多行注释function。那么，有没有人有任何好的解决方法？虽然R中的相当一部分工作通常涉及到交互式会话（这让人怀疑是否需要多行注释），但有时候我不得不向同事和同学发送脚本，其中大部分都涉及到非重要的代码块。对于来自其他语言的人来说，这是一个相当自然的问题。以前我用引号。由于string支持换行符，所以运行R脚本 " Here's my multiline comment. " a <- 10 rocknroll.lm <- lm(blah blah blah) … 工作正常。有没有人有更好的解决scheme？

Xcode命令斜线快捷方式评论只有工程有时: 当使用键盘快捷键评论或取消注释代码⌘ + /时，我遇到的Xcode问题相当不可靠。我似乎无法find一个真正的模式，但它通常发生在模拟器上构build和运行我的代码之后。直到我编辑我的任何代码文件中的东西，它将不会再工作。即使我切换到主视图中的另一个文件，通过快捷方式注释不起作用。其他键盘快捷键，如缩进⌘ + [继续工作就好了。其他人有这个问题，如果是的话，你有没有find解决办法？我知道这似乎是一个小小的投诉，但是在运行时，然后尽快地注释掉一段代码来检查效果，这有点不方便。我正在使用OXS Yosemite 10.10（14A389）上的Xcode 6.1（6A1052d），并在Objective-C for iOS中进行开发。

在BASH脚本中进行注释: 我怎样才能从脚本中对以下各行进行评论： 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' -e 's/,$//' | \ sed […]

评论界面，实施还是两者？: 我想我们都（当我们可以被打扰！）评论我们的接口。例如 /// <summary> /// Foo Interface /// </summary> public interface Foo { /// <summary> /// Will 'bar' /// </summary> /// <param name="wibble">Wibble factor</param> void Bar(string wibble); } 你也评论实施（也可能提供给客户，例如作为一个图书馆的一部分）？如果是的话，你如何pipe理保持两个同步？或者你只是添加一个“查看接口的文档”评论？谢谢

在build.gradle文件中写评论的语法是什么？: 往下看这个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' } 如果我想写一个评论为什么我select这个图书馆这个项目，在build.gradle文件中写评论的语法是什么？