草庐IT

c++ - 如何避免包含类实现文件？

coder 2024-02-26 原文

而不是做

#include "MyClass.cpp"

我想要做
#include "MyClass.h"

我已经在线阅读了而不是，这被认为是不好的做法。

最佳答案

简而言之，单独编译

首先，让我们来看一些简单的例子:

struct ClassDeclaration;   // 'class' / 'struct' mean almost the same thing here
struct ClassDefinition {}; // the only difference is default accessibility
                           // of bases and members

void function_declaration();
void function_definition() {}

extern int global_object_declaration;
int global_object_definition;

template<class T>           // cannot replace this 'class' with 'struct'
struct ClassTemplateDeclaration;
template<class T>
struct ClassTemplateDefinition {};

template<class T>
void function_template_declaration();
template<class T>
void function_template_definition() {}

翻译单元

转换单元(TU)是单个源文件(应为**。cpp *文件)及其包含的所有文件，也包括这些文件等。换句话说:预处理单个文件的结果。

header

包括后卫是一种黑客，可以解决缺乏实际模块系统的问题，从而使 header 成为一种受限制的模块。为此，多次包含同一 header 一定不能产生不利影响。

包括后卫的工作使后续的#includes无操作生效，并且第一个include中有可用的定义。由于其有限的性质，控制 header 选项的宏应在整个项目中保持一致(诸如之类的oddball header 会引起问题)，并且公共(public) header 的所有#include都应位于任何 namespace ，类等之外，通常位于任何文件的顶部。

请参阅我的包括后卫naming advice，其中包括generate include guards的简短程序。

声明

类，函数，对象和模板几乎可以在任何地方声明，可以声明多次，并且必须在以任何方式引用它们之前声明。在一些奇怪的情况下，您可以在使用类时声明它们。这里不会介绍。

定义

每个TU最多可以定义一次类[1]；当您包含特定类的标题时，通常会发生这种情况。函数和对象必须在一个TU中定义一次。当您在**。cpp *文件中实现它们时，通常会发生这种情况。但是，可以在多个TU中定义内联函数，包括类定义内的隐式内联函数，但这些定义必须相同。

出于实用目的[2]，仅在 header 中定义模板(类模板和函数模板)，如果要使用单独的文件，请使用另一个 header [3]。

[1]由于最多只能进行一次限制，因此 header 使用include防护来防止多重包含，从而防止多重定义错误。
[2]我不会在这里介绍其他可能性。
[3]命名为blahblah_detail.hpp，blahblah_private.hpp或类似名称(如果您想证明它是非公开的)。

指导方针

因此，尽管我敢肯定到目前为止，上面的一切都是泥泞的大球，但它还不到需要占用几章内容的页面，因此可以将其用作简要引用。但是，了解上述概念很重要。使用这些，这是准则的简短列表(但不是绝对规则):
  • 始终在单个项目中始终为 header 命名，例如C的**。h *和C++的**。hpp *。
  • 切勿包含不是 header 的文件。
  • 始终一致地命名实现文件(将直接编译)，例如**。c *和**。cpp *。
  • 使用可以自动编译您的源文件的构建系统。 make是一个典型的例子，但是有很多选择。在简单的情况下，请保持简单。例如，make可以使用其内置规则，甚至可以不使用makefile。
  • 使用可以生成 header 依赖项的构建系统。一些编译器可以使用-M之类的命令行开关来生成该文件，因此您可以轻松地创建surprisingly useful system。

    • 建立过程

    (以下是回答您问题的一小部分，但您需要上面的大部分内容才能到达此处。)

    当您进行构建时，构建系统将经历几个步骤，其中对于本次讨论而言，重要的步骤是:
  • 将每个实现文件编译为TU，从而生成目标文件(**。o *，**。obj *)
  • 每个都独立编译，这就是每个TU需要声明和定义
    • 的原因
  • 将这些文件以及指定的库链接到单个可执行文件
    • 中

    我建议您学习make的基础知识，因为它很流行，易于理解且易于上手。但是，这是一个存在多个问题的旧系统，您将需要在某个时候切换到其他系统。

    选择构建系统几乎是一种宗教经历，就像选择编辑器一样，不同的是您将不得不与更多的人(每个人在同一个项目上工作)一起工作，并且可能会受到先例和惯例的更多限制。您可以使用可以为您处理相同细节的IDE，但是使用全面的构建系统并没有真正的好处，您仍然应该真正了解它在做什么。

    文件模板

    例子.hpp
    #ifndef EXAMPLE_INCLUDE_GUARD_60497EBE580B4F5292059C8705848F75
#define EXAMPLE_INCLUDE_GUARD_60497EBE580B4F5292059C8705848F75
// all project-specific macros for this project are prefixed "EXAMPLE_"

#include <ostream> // required headers/"modules"/libraries from the
#include <string>  // stdlib, this project, and elsewhere
#include <vector>

namespace example { // main namespace for this project
template<class T>
struct TemplateExample { // for practical purposes, just put entire
  void f() {}            // definition of class and all methods in header
  T data;
};

struct FooBar {
  FooBar(); // declared
  int size() const { return v.size(); } // defined (& implicitly inline)
private:
  std::vector<TemplateExample<int> > v;
};

int main(std::vector<std::string> args); // declared
} // example::

#endif

    example.cpp
    #include "example.hpp" // include the headers "specific to" this implementation
// file first, helps make sure the header includes anything it needs (is
// independent)

#include <algorithm> // anything additional not included by the header
#include <iostream>

namespace example {
FooBar::FooBar() : v(42) {} // define ctor

int main(std::vector<std::string> args) { // define function
  using namespace std; // use inside function scope, if desired, is always okay
  // but using outside function scope can be problematic
  cout << "doing real work now...\n"; // no std:: needed here
  return 42;
}
} // example::

    main.cpp
    #include <iostream>
#include "example.hpp"

int main(int argc, char const** argv) try {
  // do any global initialization before real main
  return example::main(std::vector<std::string>(argv, argv + argc));
}
catch (std::exception& e) {
  std::cerr << "[uncaught exception: " << e.what() << "]\n";
  return 1; // or EXIT_FAILURE, etc.
}
catch (...) {
  std::cerr << "[unknown uncaught exception]\n";
  return 1; // or EXIT_FAILURE, etc.
}

    关于c++ - 如何避免包含类实现文件？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/2037880/

    amp43brincludeheaderc++classcoding-style

    有关c++ - 如何避免包含类实现文件？的更多相关文章

    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 - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

      总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

    3. 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

    4. ruby - 其他文件中的 Rake 任务 - 2

      我试图在一个项目中使用rake，如果我把所有东西都放到Rakefile中，它会很大并且很难读取/找到东西，所以我试着将每个命名空间放在lib/rake中它自己的文件中，我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题，但没有任务。我现在只有一个.rake文件作为测试，名为“servers.rake”，它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

    5. ruby-on-rails - 在 Rails 中将文件大小字符串转换为等效千字节 - 2

      我的目标是转换表单输入，例如“100兆字节”或“1GB”，并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前，我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效，但前提是输入是倍数(“gigabytes”，而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以，功能正常，

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

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

    7. ruby-on-rails - Rails 3 中的多个路由文件 - 2

      Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情？ 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中，使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件，我们在StackOverflow上找到一个类似的问题

    8. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

      给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息？ 最佳答案 在Rails3中，update_all不返回任何有意义的信息，除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

    9. 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

    10. ruby - 将差异补丁应用于字符串/文件 - 2

      对于具有离线功能的智能手机应用程序，我正在为Xml文件创建单向文本同步。我希望我的服务器将增量/差异(例如GNU差异补丁)发送到目标设备。这是计划:Time=0Server:hasversion_1ofXmlfile(~800kiB)Client:hasversion_1ofXmlfile(~800kiB)Time=1Server:hasversion_1andversion_2ofXmlfile(each~800kiB)computesdeltaoftheseversions(=patch)(~10kiB)sendspatchtoClient(~10kiBtransferred)Cl

    随机推荐