知识卡片
固定发布声明不等于功能注解
项目可能在文件头保留版权或发布条件等固定信息,它承担来源和项目约定的说明用途,不是重复函数做什么。书中FitNesse用短声明指向统一许可文本,避免把大段条款混进实现说明。这只是该项目的展示方式,不能从中推出任何文件的通用法律义务;具体保留内容应以所属项目实际要求为准。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
- · 第4章 注释
原书出处 · 1 处
- 第4章 注释 4.3 好注释 · 查看原书依据
只要有可能,就指向一份标准许可或其他外部文档
参考来源
- 位置:《代码整洁之道》全书 · 第4章 注释,spine013单元002;来源项目book-sources,extracted/代码整洁之道/_epub-src/OEBPS/Text/part0011.xhtml。
- 结论依据:原文以本项目文件头举例并建议引用统一文本,支持发布信息和行为说明分工,未据此给其他项目作法律判断。未在本机运行示例或改变环境。
- 原始内容:later. 这类注释不应是合同或法典。只要有可能,就指向一份标准许可或其他外部文档,而不要把所有条款放到注释中。 4.3.2 提供信息的注释 有时,用注释来提供基本信息也有其用处。例如,以下注释解释了某个抽象方法的返回值: // Returns an