C++核心准则SF.11​:头文件应该可以独立工作​

共 1553字,需浏览 4分钟

 ·

2020-10-14 01:27

SF.11: Header files should be self-contained

SF.11:头文件应该可以独立工作


Reason(原因)

Usability, headers should be simple to use and work when included on their own. Headers should encapsulate the functionality they provide. Avoid clients of a header having to manage that header's dependencies.

易用性,当只有它自己被包含时,头文件应该也容易使用和动作。头文件应该封装它们所提供的功能。避免头文件的用户不得不处理头文件之间的依赖关系。


Example(示例)

#include "helpers.h"
// helpers.h depends on std::string and includes
Note(注意)

Failing to follow this results in difficult to diagnose errors for clients of a header.

违反本准则的结果是头文件的用户难以诊断发生的错误。(因为前提是弄清楚头文件之间的依赖关系,译者注。)


Note(注意)

A header should include all its dependencies. Be careful about using relative paths because C++ implementations diverge on their meaning.

头文件应该包含所有的依赖关系。由于C++的具体实现之间的处理方式不同,因此需要小心地使用相对路径。


Enforcement(实施建议)

A test should verify that the header file itself compiles or that a cpp file which only includes the header file compiles.

检查编译的头文件或者只包含编译的头文件的cpp文件。


原文链接

https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#sf11-header-files-should-be-self-contained


新书介绍

《实战Python设计模式》是作者最近出版的新书,拜托多多关注!

本书利用Python 的标准GUI 工具包tkinter,通过可执行的示例对23 个设计模式逐个进行说明。这样一方面可以使读者了解真实的软件开发工作中每个设计模式的运用场景和想要解决的问题;另一方面通过对这些问题的解决过程进行说明,让读者明白在编写代码时如何判断使用设计模式的利弊,并合理运用设计模式。

对设计模式感兴趣而且希望随学随用的读者通过本书可以快速跨越从理解到运用的门槛;希望学习Python GUI 编程的读者可以将本书中的示例作为设计和开发的参考;使用Python 语言进行图像分析、数据处理工作的读者可以直接以本书中的示例为基础,迅速构建自己的系统架构。




觉得本文有帮助?请分享给更多人。

关注微信公众号【面向对象思考】轻松学习每一天!

面向对象开发,面向对象思考!



浏览 39
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报