你遇到过的源代码中最好的注释是什么?
当前回答
这是众所周知的,但我喜欢它(在sys/ufs/ufs_vnops.c中):
/*
* A virgin directory (no blushing please).
*/
在FreeBSD内核源代码树中(甚至在之前,回到4.xBSD)
其他回答
我没有亲身经历过这种情况,但这是一个很好的故事(详见我的评论中的解释):
#define MSGTAG_B33R 0x723 /* RIPLVB */
当我注释掉我认为不再有用的代码块,但我可能是错的(因此没有删除它们),我有时会在它们之前
// Wilted celery?
这个想法就像芹菜一样枯萎了,但你还是把它放回冰箱里。我只知道十年后会有人看到这些评论,说什么鬼?
// Hey, your shoe's untied!
后面跟着一些可疑的代码,在这些代码中,
// Keep looking! I think it was the other shoe!
最后,
// How strange -- I must be seeing things. Anyhow, I'm going to go take a shower, now...
以下注释来自我必须调试的一个旧项目:
//Haleluya i can go home!
我在COBOL程序中看到的一些东西让我感到恐惧
* All comments pertain to the lines which follow.
这是什么意思?
有人对评论感到不舒服,以至于不得不写一个元评论? 有人习惯将注释放在相关代码的下面,而被告知要将注释放在上面?这是怎么发生的?
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?