c++ - C++编码样式

coder 2024-02-22 原文

Closed. This question is opinion-based。它当前不接受答案。

想改善这个问题吗？更新问题，以便editing this post用事实和引用来回答。

7年前关闭。

Improve this question

不确定我的问题是否适合StackOverflow问题的所有规则，但我认为这将对将来的用户有所帮助。

现在，我需要为我参与的一些C++项目选择编码风格。这些项目足够大，每个项目都会有一些程序员在工作。因此，我们需要均衡我们的代码样式。另外，我们希望选择一种社会上可以接受的编码样式，因此首先，我将告诉我们我们已经决定要拥有的样式。我的问题是，我们的某些选择是否在社会上不被接受，还有其他一些通常使用C++编码样式规则的选择。

所以我们在这里选择了什么:

文件命名

以大写字母开头，每个新单词都有一个大写字母(没有下划线，没有空格)。

例如:

VeryImportantClass.h
VeryImportantClass.cpp

命名空间命名

以大写字母开头，每个新单词都有一个大写字母(没有下划线，没有空格)。对齐也应适当。

例如:

namespace Drinks
{
    namespace AlcoholDrinks
    {

    }
}

命名空间结构

在头文件中，只有函数/方法原型(prototype)，可以在cpp文件中实现，请避免将using namespace用于实现文件。

例:

//header
namespace CommonStuff
{
    namespace SystemParameters
    {
        bool IfWindows();
        //some more stuff...
    }
}

//cpp file
namespace CommonStuff
{
    namespace SystemParameters
    {
        bool IfWindows()
        {
            //some stuff...
            return ...;
        }
    }
}

类和结构的命名

以大写字母开头，每个新单词都有一个大写字母(没有下划线，没有空格)。没有C之类的前缀或S之类的结构前缀。我们决定-它只是要输入更多内容。

例:

class MyClass
{

};

struct MyStruct
{

};

类或结构

在某些情况下，很难理解我们是否需要类或结构。如果结构仅保留一些分组的数据，则为struct。如果结构保留数据并具有方法，则为class。异常方法是构造函数，析构函数和比较运算符。

例:

class MyClass
{
public:
    MyClass();
    ~MyClass();
    void SetValue(int value);
    int GetValue();
    void PrintValue();
private:
    int m_value;
};

struct MyStruct
{
    MyStruct();
    ~MyStruct();    
    int value;
};

类型名称

以大写字母开头，每个新单词都有一个大写字母(没有下划线)。

例如:

typedef std::string String;
typedef std::vector<String> StringVector;

变量类型

使用我们自己的预定义类型，我们有:

typedef std::string String;
typedef std::vector<String> StringVector;
typedef unsigned char Byte;
typedef std::vector<Byte> ByteVector;
//etc.

变量命名

以小写字母开头，每个新单词都有一个大写字母(没有下划线)。

例:

String messageLicenseExpired = "Your product version is expired, please...";
int importantNumber = 13;

类变量命名

以前缀 m_ 开头，然后单词以小写字母开头，每个新单词都有一个大写字母(无下划线)。

例:

int m_myVariable;
int m_otherVariable;

常数

所有大写字母都带有下划线。

例:

const String PRODUCT_NAME = "our product";
const Byte IMPORTANT_NUMBER = 13;

常数或预处理器

如果将使用#ifdef或其他一些值来检查值，则该值必须是预处理程序定义。否则为const。

例如:

#define FAILURE_FACTOR_FOR_DEBUG 50
const int MAGIC_NUMBER = 5;

//some code...

String newString = someString.substr(MAGIC_NUMBER);

//some code...

//not the best example, but I think it is understandable.
#ifdef _DEBUG
    int someValue = FAILURE_FACTOR_FOR_DEBUG;
#else
    int someValue = 0;
#end

功能和方法命名

以大写字母开头，每个新单词都有一个大写字母(没有下划线)。

例如:

int CalculateSometing (int n);
void ToUpper (String& someStr);

大括号

除初始化外，大括号应始终换行。

例:

int arr[] = {1, 2, 3};
if (arr[0] > 10)
{
    //do something
}
else
{
    //do something else
}

其他
else属于换行符，请参见前面的示例。

if语句和花括号

即使是if或else之后的单个代码行也应包含在内。

例:

if (someInt > 100)
{
    someInt = 100;
}
else
{
    someInt /= 2;
}

方法调用

箭头和点周围没有空格。

例:

Object obj;
Object* oPtr = new Object();

obj.Method();
obj->Method();

头文件

使用#pragma once代替定义防护。 (#pragma once不是标准的，因此在某些编译器中必须定义防护措施)

仅一类的 header 。

头文件仅用于定义。执行指令必须在相关的cpp文件中，即使它是getter或setter也是如此。这是因为头文件的更改导致需要长时间编译。

指针和引用

如果可能，请使用引用而不是指针。如果可能，将参数作为引用传递给对象(对于对象)，则在不更改值的情况下，最好将其作为const引用传递。

例:

String ToUpper(String str);           //bad
String ToUpper(String& str);          //better
String ToUpper(const String& str);    //best
void ToUpper(String& str);            //also solution

错误处理

如果函数可能失败，则必须返回bool值true表示成功，而false表示失败。对于类方法，必须使用GetLastError()。对于可能失败的功能，应通过附加参数返回错误代码，例如bool Function(int param, int* errorCode = NULL)我们还决定在代码中不使用异常。

类结构

在头文件中，第一个公共(public)方法(位于它们顶部的构造函数和析构函数)， protected 方法， protected 变量，私有(private)方法，私有(private)变量。没有公共(public)变量，请使用getter和setter。

例:

class MyClass
{
public:
    MyClass();
    ~MyClass();
    int GetPrivateValue();
    void SetPrivateValue(int value);
    int GetProtectedValue();
    void SetProtectedValue(int value);
protected:
    void SomeMethod();
    int m_protectedValue;
private:
    void SomePrivateMethod();
    int m_privateValue;
};

格式化

对齐方式使用4个空格或制表符。

长行换行，不再有120个符号的行。

自我记录代码

总是欢迎使用注释，但最好的选择是为变量和函数命名，以解释所有内容。

例:

void Function (const String& str, const String& str2, StringVector& vect);   //very bad

//This functions tokenize string, str is input string, str2 is delimiters string, vect output
void Function (const String& str, const String& str2, StringVector& vect);    //quite bad

void Tokenize (const String& inputString, const String& delimiters, StringVector& output);    //good, anyway comments using this declaration also welcome.

＆和*位置

在变量类型之后立即编写&和*。

例:

String* strPtr;
String& strRef;

这是我们决定使用的所有东西，问题是，我们是否错过了某些东西？另外，在全局范围内有什么 Not Acceptable 吗？

随意发表评论并询问是否不清楚，为什么我们选择了一些。

希望对以后的读者有所帮助。

最佳答案

受尊敬的机构可以使用许多编码标准:

这是一个很好的https://wiki.ucar.edu/download/attachments/25039241/european_space_agency_standards.pdf

关于c++ - C++编码样式，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/18170944/

上一篇：C++ Lua 错误处理

下一篇：c++ - 缺少哪个用户的帧缓冲区？

相关文章：

c++ - 二叉搜索树插入垃圾数据

c++ - C++中静态多态性背后的动机是什么？

java - Java 中单独的 { code } 是做什么用的？

perl - 是否有一个 perl 模块可以启动一个进程并将三个主要 I/O 句柄返回给该进程？

c++ - linux c++ xlib，如何使用 XSaveContext 和 XFindContext(提供示例)

c++ - 分配抽象类类型 'CObject' 的对象

c++ - 带有可选参数的构造函数

ruby - 单个数组参数与多个参数

language-agnostic - 如何使开发人员遵循编码标准？

c++ - 如何在使用 const "this"指针时获取非常量迭代器？

amp 43 code br 大写字母 c++coding-style

有关c++ - C++编码样式的更多相关文章

ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby 中生成它们？ - 2
我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%
ruby - 用逗号、双引号和编码解析 csv - 2
我正在使用ruby1.9解析以下带有MacRoman字符的csv文件#encoding:ISO-8859-1#csv_parse.csvName,main-dialogue"Marceu","Giveittohimóhe,hiswife."我做了以下解析。require'csv'input_string=File.read("../csv_parse.rb").force_encoding("ISO-8859-1").encode("UTF-8")#=>"Name,main-dialogue\r\n\"Marceu\",\"Giveittohim\x97he,hiswife.\"\
ruby - 如何使用文字标量样式在 YAML 中转储字符串？ - 2
我有一大串格式化数据(例如JSON)，我想使用Psychinruby同时保留格式转储到YAML。基本上，我希望JSON使用literalstyle出现在YAML中:---json:|{"page":1,"results":["item","another"],"total_pages":0}但是，当我使用YAML.dump时，它不使用文字样式。我得到这样的东西:---json:!"{\n\"page\":1,\n\"results\":[\n\"item\",\"another\"\n],\n\"total_pages\":0\n}\n"我如何告诉Psych以想要的样式转储标量？解
ruby-on-rails - 如何优雅地重启 thin + nginx？ - 2
我的瘦服务器配置了nginx，我的ROR应用程序正在它们上运行。在我发布代码更新时运行thinrestart会给我的应用程序带来一些停机时间。我试图弄清楚如何优雅地重启正在运行的Thin实例，但找不到好的解决方案。有没有人能做到这一点？最佳答案 #Restartjustthethinserverdescribedbythatconfigsudothin-C/etc/thin/mysite.ymlrestartNginx将继续运行并代理请求。如果您将Nginx设置为使用多个上游服务器，例如server{listen80;server
ruby - 如何在 Ruby 中拆分参数字符串 Bash 样式？ - 2
我正在为一个项目制作一个简单的shell，我希望像在Bash中一样解析参数字符串。foobar"helloworld"fooz应该变成:["foo","bar","helloworld","fooz"]等等。到目前为止，我一直在使用CSV::parse_line，将列分隔符设置为""和.compact输出。问题是我现在必须选择是要支持单引号还是双引号。CSV不支持超过一个分隔符。Python有一个名为shlex的模块:>>>shlex.split("Test'helloworld'foo")['Test','helloworld','foo']>>>shlex.split('Test"
C# 到 Ruby sha1 base64 编码 - 2
我正在尝试在Ruby中复制Convert.ToBase64String()行为。这是我的C#代码:varsha1=newSHA1CryptoServiceProvider();varpasswordBytes=Encoding.UTF8.GetBytes("password");varpasswordHash=sha1.ComputeHash(passwordBytes);returnConvert.ToBase64String(passwordHash);//returns"W6ph5Mm5Pz8GgiULbPgzG37mj9g="当我在Ruby中尝试同样的事情时，我得到了相同sha
ruby-on-rails - 添加回形针新样式不影响旧上传的图像 - 2
我有带有Logo图像的公司模型has_attached_file:logo我用他们的Logo创建了许多公司。现在，我需要添加新样式has_attached_file:logo,:styles=>{:small=>"30x15>",:medium=>"155x85>"}我是否应该重新上传所有旧数据以重新生成新样式？我不这么认为……或者有什么rake任务可以重新生成样式吗？最佳答案参见Thumbnail-Generation.如果rake任务不适合你，你应该能够在控制台中使用一个片段来调用重新处理!关于相关公司
ruby - 使用 `+=` 和 `send` 方法 - 2
如何将send与+=一起使用？a=20;a.send"+=",10undefinedmethod`+='for20:Fixnuma=20;a+=10=>30 最佳答案恐怕你不能。+=不是方法，而是语法糖。参见http://www.ruby-doc.org/docs/ProgrammingRuby/html/tut_expressions.html它说Incommonwithmanyotherlanguages,Rubyhasasyntacticshortcut:a=a+2maybewrittenasa+=2.你能做的最好的事情是:
ruby - 如何计算 Liquid 中的变量 +1 - 2
我对如何计算通过{%assignvar=0%}赋值的变量加一完全感到困惑。这应该是最简单的任务。到目前为止，这是我尝试过的:{%assignamount=0%}{%forvariantinproduct.variants%}{%assignamount=amount+1%}{%endfor%}Amount:{{amount}}结果总是0。也许我忽略了一些明显的东西。也许有更好的方法。我想要存档的只是获取运行的迭代次数。最佳答案因为{{incrementamount}}将输出您的变量值并且不会影响{%assign%}定义的变量，我
ruby-on-rails - 有没有一种工具可以在编码时自动保存对文件的增量更改？ - 2
我最喜欢的Google文档功能之一是它会在我工作时不断自动保存我的文档版本。这意味着即使我在进行关键更改之前忘记在某个点进行保存，也很有可能会自动创建一个保存点。至少，我可以将文档恢复到错误更改之前的状态，并从该点继续工作。对于在MacOS(或UNIX)上运行的Ruby编码器，是否有具有等效功能的工具？例如，一个工具会每隔几分钟自动将Gitcheckin我的本地存储库以获取我正在处理的文件。也许我有点偏执，但这点小保险可以让我在日常工作中安心。最佳答案虚拟机有些人可能讨厌我对此的回应，但我在编码时经常使用VIM，它具有自动保存功

c++ - C++编码样式

有关c++ - C++编码样式的更多相关文章

随机推荐