你遇到过的源代码中最好的注释是什么?
当前回答
这个注释位于一个包含接口的单元中,这些接口用于绑定主应用程序和各种第三方驱动程序之间的通信。
//**************************************
// Dear code maintainer:
//
// This source contains COM interfaces, not to be confused with interfaces
// of any other sort, please do not just willy-nilly add additional methods
// to these interfaces as they are truely immutable, unlike the interfaces
// that other software vendors like Microsoft maintain. IF you need to add
// new functionality, then go thru the trouble of creating a NEW interface
// and implement this functionality on only the objects you need.
//
// While the money is good for fixing all of the problems caused by not
// following the rules, I would rather work on things which actually have
// an impact on the future of the product rather than curse and yell
// obsenities at the screen because someone didn't bother to understand the
// true meaning of IMMUTABLE.
//**************************************
其他回答
我经常看到这种情况:
// TODO make this work
从Joomla !来源:
// fudge the group stuff
刚从大学毕业的我渴望亲自动手。我的第一个任务是……“为我注释此代码”。
傻瓜。
过了一段时间我就厌倦了……
// this function doesn't actually calculated the profit, like it says --it really signals the mothership orbiting saturn that the planet is ripe for takeover
[later]
// I don't think anyone is going to read this
[various permutations on that last one]
try
{
...
}
catch(Exception ex)
{
//if this happens the world is going to end...
}
现在猜猜发生了什么……
从/系统/图书馆/框架/ AppKit.framework /版本/ C /头/ NSTextView.h:
- (void)smartInsertForString:(NSString *)pasteString replacingRange:(NSRange)charRangeToReplace beforeString:(NSString **)beforeString afterString:(NSString **)afterString;
- (NSString *)smartInsertBeforeStringForString:(NSString *)pasteString replacingRange:(NSRange)charRangeToReplace;
- (NSString *)smartInsertAfterStringForString:(NSString *)pasteString replacingRange:(NSRange)charRangeToReplace;
/* Java note: The second and third methods are the primitives and are the
methods exposed in Java. The first method calls the other two. All
Objective-C code calls the first method. In either Objective-C or Java any
overriding should be done for the second and third methods, not the first
method. This will all work out correctly with the exception of existing code
that overrides the first method. Existing subclasses that do this will not
have their implementations available to Java developers. Isn't Java wonderful? */
推荐文章
- 在VS Code中禁用“Comments are not allowed In JSON”错误
- Swift:理解// MARK
- 在构建中编写注释的语法是什么?gradle文件?
- Java注释中的/**和/*
- 有没有办法注释掉.ASPX页面中的标记?
- Jenkins:注释可以添加到Jenkins文件中吗?
- TypeScript注释的语法记录在哪里?
- CSV文件可以有注释吗?
- 什么是自文档化代码?它能取代文档化良好的代码吗?
- 在erb中添加注释的最佳方法
- 为什么Python没有多行注释?
- 我应该在批处理文件中使用哪种注释风格?
- 如何在Office VBA编辑器中注释和取消注释代码块
- “# noqa”在Python注释中是什么意思?
- 我可以向pip需求文件添加注释吗?