gpt4 book ai didi

c++ - 将C++类代码分割成多个文件,有哪些规则?

转载 作者:IT老高 更新时间:2023-10-28 12:58:23 27 4
gpt4 key购买 nike

思考时间 - 你为什么要拆分你的文件?
正如标题所暗示的,我遇到的最终问题是多个定义链接器错误。我实际上已经解决了问题,但我没有以正确的方式解决问题。在开始之前,我想讨论将类文件拆分为多个文件的原因。我已经尝试将所有可能的情况放在这里 - 如果我错过了任何一个,请提醒我,我可以进行更改。希望以下内容是正确的:
原因 1 为了节省空间:
您有一个包含所有类成员的类声明的文件。您在此文件周围放置 #include 保护(或 #pragma once)以确保在将文件 #include 包含在两个不同的头文件中时不会发生冲突,然后将它们包含在源文件中。您使用此类中声明的任何方法的实现编译一个单独的源文件,因为它从源文件中卸载了许多代码行,这会稍微清理一些内容并为您的程序引入一些顺序。
示例:如您所见,可以通过将类方法的实现拆分到不同的文件中来改进以下示例。 (一个 .cpp 文件)

// my_class.hpp
#pragma once

class my_class
{
public:
void my_function()
{
// LOTS OF CODE
// CONFUSING TO DEBUG
// LOTS OF CODE
// DISORGANIZED AND DISTRACTING
// LOTS OF CODE
// LOOKS HORRIBLE
// LOTS OF CODE
// VERY MESSY
// LOTS OF CODE
}

// MANY OTHER METHODS
// MEANS VERY LARGE FILE WITH LOTS OF LINES OF CODE
}
原因 2 要防止多个定义链接器错误:
也许这就是您将实现与声明分开的主要原因。在上面的示例中,您可以将方法主体移到类之外。这将使它看起来更干净和结构化。然而,根据这个 question , 上面的例子隐含了 inline说明符。将实现从类内移动到类外,如下例所示,将导致链接器错误,因此您要么内联所有内容,要么将函数定义移动到 .cpp 文件。
示例: _如果您不将函数定义移动到 .cpp 文件或将函数指定为内联函数,则下面的示例将导致“多定义链接器错误”。
// my_class.hpp
void my_class::my_function()
{
// ERROR! MULTIPLE DEFINITION OF my_class::my_function
// This error only occurs if you #include the file containing this code
// in two or more separate source (compiled, .cpp) files.
}
要解决问题:
//my_class.cpp
void my_class::my_function()
{
// Now in a .cpp file, so no multiple definition error
}
或者:
// my_class.hpp
inline void my_class::my_function()
{
// Specified function as inline, so okay - note: back in header file!
// The very first example has an implicit `inline` specifier
}
原因 3 您想再次节省空间,但这次您使用的是模板类:
如果我们使用模板类,则无法将实现移动到源文件(.cpp 文件)。目前(我假设)标准或当前编译器都不允许这样做。与 的第一个例子不同原因 2 ,上面,我们可以将实现放在头文件中。根据这个 question原因是模板类方法也隐含了 inline说明符。那是对的吗? (这似乎有道理。)但似乎没有人知道我刚刚提到的问题!
那么,下面的两个例子是否相同?
// some_header_file.hpp
#pragma once

// template class declaration goes here
class some_class
{
// Some code
};

// Example 1: NO INLINE SPECIFIER
template<typename T>
void some_class::class_method()
{
// Some code
}

// Example 2: INLINE specifier used
template<typename T>
inline void some_class::class_method()
{
// Some code
}
如果您有一个模板类头文件,由于您拥有的所有函数,它变得越来越大,那么我相信您可以将函数定义移动到另一个头文件(通常是 .tpp 文件?)然后 #include file.tpp在包含类声明的头文件末尾。但是,您不能在其他任何地方包含此文件,因此 .tpp而不是 .hpp .
我假设您也可以使用常规类的内联方法来做到这一点?这也允许吗?
提问时间
所以我在上面做了一些陈述,其中大部分与源文件的结构有关。我认为我说的一切都是正确的,因为我做了一些基础研究并“发现了一些东西”,但这是一个问题,所以我不确定。
这归结为,您将如何在文件中组织代码。我想我已经找到了一个永远有效的结构。
这是我想出的。 (这是我的类代码文件组织/结构标准,如果你喜欢。不知道它是否会很有用,这是问的重点。)
  • 1:.hpp 中声明类(模板或其他)文件,包括所有方法、友元函数和数据。
  • 2:底部.hpp文件,#include .tpp包含任何 inline 的实现的文件方法。创建 .tpp文件并确保所有方法都指定为 inline .
  • 3:所有其他成员(非内联函数、友元函数和静态数据)应在 .cpp 中定义文件,其中 #include.hpp文件在顶部以防止诸如“类 ABC 尚未声明”之类的错误。由于此文件中的所有内容都具有外部链接,因此程序将正确链接。

  • 工业上有这样的标准吗?我提出的标准是否适用于所有情况?

    最佳答案

    你的三点听起来是对的。这是做事的标准方式(虽然我以前没有见过 .tpp 扩展名,通常是 .inl),尽管我个人只是将内联函数放在头文件的底部而不是单独的文件中。

    这是我整理文件的方式。我省略了简单类的前向声明文件。

    myclass-fwd.h

    #pragma once

    namespace NS
    {
    class MyClass;
    }

    我的类.h
    #pragma once
    #include "headers-needed-by-header"
    #include "myclass-fwd.h"

    namespace NS
    {
    class MyClass
    {
    ..
    };
    }

    我的类.cpp
    #include "headers-needed-by-source"
    #include "myclass.h"

    namespace
    {
    void LocalFunc();
    }

    NS::MyClass::...

    根据偏好用头部防护替换 pragma ..

    这种方法的原因是减少头文件依赖性,这会减慢大型项目的编译时间。如果您不知道,您可以转发声明一个类以用作指针或引用。只有在构造、创建或使用类成员时才需要完整声明。

    这意味着使用该类的另一个类(通过指针/引用获取参数)只需要在它自己的头中包含 fwd 头。然后将完整的头文件包含在第二个类的源文件中。这大大减少了在拉入一个大头时你得到的不需要的垃圾量,这会拉入另一个大头,然后拉入另一个......

    下一个技巧是未命名的命名空间(有时称为匿名命名空间)。这只能出现在源文件中,就像一个隐藏的命名空间,只对那个文件可见。您可以在此处放置仅由源文件使用的本地函数、类等。如果您在两个不同的文件中创建具有相同名称的内容,这可以防止名称冲突。 (例如两个本地函数 F,可能会出现链接器错误)。

    关于c++ - 将C++类代码分割成多个文件,有哪些规则?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/18535621/

    27 4 0
    Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
    广告合作:1813099741@qq.com 6ren.com