考虑这个(可怕的,可怕的,没有好的,非常糟糕的)代码结构:
#define foo(x) // commented out debugging code
// Misformatted to not obscure the point
if (a)
foo(a);
bar(a);
我已经看到两个编译器的预处理器在这段代码上生成不同的结果:
if (a)
bar(a);
和
if (a)
;
bar(a);
显然,对于可移植的代码库来说这是一件坏事.
我的问题:预处理器应该用这个做什么？首先是Elide评论,还是先扩展宏？
是否可以在XML标记内注释一个或多个属性？/* */来自C的东西
我尝试过使用<!-- -->,但没有成功.
<element
attribute1="value1"
attribute2="value2"
<!-- attribute3="value3" (commented value) -->
>
评论功能是否有公认的最佳实践？我只知道doxygen风格,但C++没有正式支持它,就像Javadocs是Java一样,只是想知道什么是最好的.
我想知道是否有任何方法可以注释掉部分行,就像你可以用c ++一样/*this*/.我所知道的唯一评论# this总是在线的末尾和"""these"""那些在中线不起作用的注释.
示例用例:使用子进程并需要临时注释掉-p 0列表中的参数:
['../some/guy', '-m', '10', '-p', '0', '-n', '100', '-f', '/dev/stdout']
有一个键盘快捷键可以注释掉一个选项会很高兴,此刻我只是复制整行,如下所示
#['../some/guy', '-m', '10', '-p', '0', '-n', '100', '-f', '/dev/stdout']
['../some/guy', '-m', '10', '-n', '100', '-f', '/dev/stdout']
我期待一个大胖子'不',但我想这不会有问题,python几次让我感到惊讶.
在我们的项目中,我们有很多TH生成的函数.向它们添加通用注释是有意义的,以便它们在Haddock/Hoogle中可见.至少,像"这是由TH生成的".有可能吗？
我习惯使用atlas,首选(据我所知)方法是使用xml注释,例如:
/// <summary>
/// Method to calculate distance between two points
/// </summary>
///
/// <param name="pointA">First point</param>
/// <param name="pointB">Second point</param>
///
function calculatePointDistance(pointA, pointB) { ... }
最近我一直在寻找其他第三方JavaScript库,我看到的语法如下:
/*
* some comment here
* another comment here
* ...
*/
function blahblah() { ... }
作为奖励,如果有任何可以读取"首选"评论风格的JavaScript API生成器,请告诉我.
当我们#用于在Python中插入注释时,Python如何采用:
# -*- coding: utf-8 -*-
不同？
我想知道是否有办法在shell脚本中注释掉一组行.我怎么能这样做？我们可以在其他编程语言中使用/**/.当我转换/使用/修改另一个脚本并且我想保留原始行而不是删除时,这是最有用的.
对于未使用的所有行,查找和前缀#似乎是一项繁琐的工作.
可以说脚本中有100行代表不使用的行.我想一次性评论它们.那可能吗？
以下陈述是什么意思？
/* (non-Javadoc)
*
* Standard class loader method to load a class and resolve it.
*
* @see java.lang.ClassLoader#loadClass(java.lang.String)
*/
@SuppressWarnings("unchecked")
这看起来像是一个基本问题,但我无法找到答案的MSDN文章或StackOverflow问题:是否可以在T4模板中进行行注释或阻止注释？我不打算生成带注释的代码(这很容易和直接),而是注释掉我的T4标记块.那可能吗？