你遇到过的源代码中最好的注释是什么?
当前回答
我们的团队,就在今晚,发布了一个新版本的CSS文件,删除了一个文件的注释,该文件的结构是这样的:
@charset "UTF-8";
/* Who knew comments here could COMPLETELY ruin our page in Safari? */
body {
/* Really important stuff here */
/* Of course, comment or not, this will all get ignored by Safari because
its the first rule after the comments which break everything.
see http://www.w3.org/International/questions/qa-css-charset for the exact details!
*/
}
有趣的是,在网上你会发现人们的解决方案是输入一个虚假的元素作为字符集语句下面的第一条规则,然后被忽略,照常进行…
发人深省的问题:该把不评论的评论放在哪里?
旁注:我知道这是不需要的,因为头,元规则等。不幸的是,我们需要它作为一个catch all:(
其他回答
当我在高中上计算机课的时候,我们在一个普通的教室里上课——没有电脑。我们所有的测试都是在纸上完成的,一张纸上有一节课。我们的老师是第一次用c++授课,偶尔会在黑板上切换到Pascal模式。这很尴尬,因为我们中很少有人对学习帕斯卡感兴趣。
对于比课堂作业更大的作业,我们会在家里做,并提交代码和输出打印结果来评分。在提交了一些代码+输出输出后,我们共同意识到老师实际上并没有阅读代码-只是打印输出。为了测试我们的理论,我在代码的第三页放了一条注释——就在一些类声明之间:
// If you are reading this, please place a checkmark here [ ]
当然,我把它拿回来的时候,前面有一个大大的蓝色“a”,没有任何标记。
<!-- Here it is -->
没有其他评论了。直到今天我都不知道“它”是什么。
try
{
...
}
catch(Exception ex)
{
//if this happens the world is going to end...
}
现在猜猜发生了什么……
#define SHIT_HAPPENED (BASE + 1) /* generic shit happened */
/**---------START-----------**/
// IMPLEMENTATION GOES HERE
/**---------END-----------**/
但没有代码;)