jjzjj

C++ - 使用#include <ClassName> 而不是#include <classname.h> 有好处吗？

coder 2023-11-14 原文

我知道标准库使用 include with .h 用于旧的 C 库，而 include without .h 用于最新的库。但是，对于自己的类(class)来说，更好的做法是什么？

在我工作的地方，我们总是有一个 include 文件夹，每个类有两个文件:classname.h 和 ClassName。 ClassName 包含 classname.h，classname.h 包含真正的类头文件。要包含一个类，您然后使用

#include <ClassName>

Qt 就是这样做的，我很确定 Qt 是他们开始在我的公司这样做的原因。但这有什么好处吗？

缺点很明显，我认为:

  • 要为新类创建另一个文件(我们使用 bash 脚本来创建，但仍然如此)
  • 每个类(class)多管理一个文件
  • 通过 IDE 重命名文件/类时，您通常必须手动调整 ClassName 文件(即使 Qt Creator 也做不到)
  • 除了 std 库和 Qt，我从未在任何地方见过这种风格

你使用这种风格吗？如果是这样，为什么？它的论据是什么？还有更多反对意见吗？

最佳答案

首先，我要编一个术语，称之为“特定类包含文件”或“CSIF”。这些文件不以 .h 结尾，即使它们像标题一样使用，因此是“包含文件”部分。既然我要继续提到这个东西，我不妨也给它一个首字母缩略词。

这是如何在Qt中实现的

Qt 有一个“头”文件，每个定义的 Qt 没有扩展名 class或 struct ，这个答案被称为 CSIF。 CSIF 直接进入 \include带有普通头文件的路径，但是如果你打开一个头文件，它们都会做同样的事情。让我们从 QtWidgets 中的包含文件开始，尤其是与 QStyleOption 相关的那些:

\include
    ...
    QStyleOption
    qstyleoption.h
    QStyleOptionButton
    QStyleOptionComboBox
    ...

如果你打开其中一个 QStyleOption -相关的CSIF，都包含一行代码:

#include "qstyleoption.h"

并且在 qstyleoption.h :

#include "../../src/widgets/styles/qstyleoption.h"

CSIF 所做的就是 #include源代码树中以其命名的类的正确 header 。 它在类的实际定义和 #include 之间创建了一个抽象级别声明需要使用它。结果，这段代码:

//In some .cpp file somewhere
#include <QStyleOptionButton>
#include <QStyleOptionComboBox>

包含相同的头文件(当然，由守卫保护)，但使用 Qt 的开发人员不需要知道这一点。开发人员只关心他/她正在使用一个类，并且他/她想确定该类是否可用。 我不知道这是不是原来的逻辑，但就是这样。

具体问题的答案

<强>1。你用这种风格吗？如果是，为什么？
是的，但只是因为我正在从事的项目模拟了 Qt 库的风格，所以 Qt 开发人员可以在 Qt 旁边舒适地使用它。否则，[插入大量咒骂]。

<强>2。它的论据是什么？
我所知道的唯一好的论据是上面的，关于 Qt 如何使用它来抽象类及其定义的位置。作为 Qt 的用户，确保包含正确的头文件是轻而易举的事。如果我使用类 QFoo ，我包括:<QFoo> .简单。

<强>3。还有更多的反对意见吗？
正如您在问题中指出的那样，有很多反对意见。

  • 它使重构变得更加困难。
  • 只有在开发库时它才真正有用。
  • 只有当您的库具有 API 稳定性保证并且相当成熟时，才值得您花时间，因为它会使重构变得更加困难。
  • 这意味着您的库导出的每个类都必须有一个 CSIF，很容易漏掉一个。

我相信其他人可以想出更多 CSIF 让生活变得困难的例子。总之，在做出决定之前，必须权衡它在您的库中增加的刚性与最终开发人员的好处之间的平衡。

至于您的工作场所如何使用它……我只是耸耸肩。也许有人在不明白为什么的情况下复制了 Qt 样式？

关于C++ - 使用#include <ClassName> 而不是#include <classname.h> 有好处吗？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/37460286/

ampincludecodestrongc++qt

有关C++ - 使用#include <ClassName> 而不是#include <classname.h> 有好处吗？的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇，就使用ruby​​onrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？ 最佳答案 不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提

  5. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？ 最佳答案 三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  6. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封，在我看来soap请求没有正确的命名空间。任何人都可以建议我

  7. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  8. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t

  9. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过，我不想只删除标签，我想智能地保留尽可能多的格式。为插入换行符标签，检测段落并格式化它们等。输入非常简单，通常是格式良好的html(不是整个文档，只是一堆内容，通常没有anchor或图像)。我可以将几个正则表达式放在一起，让我达到80%，但我认为可能有一些现有的解决方案更智能。 最佳答案 首先，不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案，它会随着HTML的变化而崩溃，或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  10. ruby - 在 64 位 Snow Leopard 上使用 rvm、postgres 9.0、ruby 1.9.2-p136 安装 pg gem 时出现问题 - 2

    我想为Heroku构建一个Rails3应用程序。他们使用Postgres作为他们的数据库，所以我通过MacPorts安装了postgres9.0。现在我需要一个postgresgem并且共识是出于性能原因你想要pggem。但是我对我得到的错误感到非常困惑当我尝试在rvm下通过geminstall安装pg时。我已经非常明确地指定了所有postgres目录的位置可以找到但仍然无法完成安装:$envARCHFLAGS='-archx86_64'geminstallpg--\--with-pg-config=/opt/local/var/db/postgresql90/defaultdb/po

随机推荐