C++ Dos and Don'ts

转自:https://chromium.googlesource.com/chromium/src/+/HEAD/styleguide/c++/c++-dos-and-donts.md

cpp最应该遵守的规则,新手学习,老手复习,挺有意义的。

A Note About Usage

Unlike the style guide, the content of this page is advisory, not required. You can always deviate from something on this page, if the relevant author/reviewer/OWNERS agree that another course is better.

Minimize Code in Headers

  • Remove #includes you don‘t use. Unfortunately, Chromium lacks include-what-you-use (“IWYU”) support, so there’s no tooling to do this automatically. Look carefully when refactoring.
  • Where possible, forward-declare nested classes, then give the full declaration (and definition) in the .cc file.
  • Defining a class method in the declaration is an implicit request to inline it. Avoid this in header files except for cheap non-virtual getters and setters. Note that constructors and destructors can be more expensive than they appear and should also generally not be inlined.

Static variables

Dynamic initialization of function-scope static variables is thread-safe in Chromium (per standard C++11 behavior). Before 2017, this was thread-unsafe, and base::LazyInstance was widely used. This is no longer necessary. Background can be found in this thread and this thread.

void foo() {
  static int ok_count = ComputeTheCount();  // OK; a problem pre-2017.
  static int good_count = 42;               // Done before dynamic initialization.
  static constexpr int better_count = 42;   // Even better (likely inlined at compile time).
  static auto& object = *new Object;        // For class types.
}

Explicitly declare class copyability/movability

The Google Style Guide says classes can omit copy/move declarations or deletions “only if they are obvious”. Because “obvious” is subjective and even the examples in the style guide take some thought to figure out, being explicit is clear, simple, and avoids any risk of accidental copying.

Declare or delete these operations in the public section, between other constructors and the destructor; DISALLOW_COPY_AND_ASSIGN is deprecated. For a non-copyable/movable type, delete the copy operations (the move operations will be implicitly deleted); otherwise, declare either copy operations, move operations, or both (a non-declared pair will be implicitly deleted). Always declare or delete both construction and assignment, not just one (which can introduce subtle bugs).

Variable initialization

There are myriad ways to initialize variables in C++11. Prefer the following general rules:

  1. Use assignment syntax when performing “simple” initialization with one or more literal values which will simply be composed into the object: int i = 1; std::string s = "Hello"; std::pair<bool, double> p = {true, 2.0}; std::vector<std::string> v = {"one", "two", "three"}; Using ‘=’ here is no less efficient than “()” (the compiler won‘t generate a temp + copy), and ensures that only implicit constructors are called, so readers seeing this syntax can assume nothing complex or subtle is happening. Note that “{}” are allowed on the right side of the ‘=’ here (e.g. when you’re merely passing a set of initial values to a “simple” struct/ container constructor; see below items for contrast).
  2. Use constructor syntax when construction performs significant logic, uses an explicit constructor, or in some other way is not intuitively “simple” to the reader: MyClass c(1.7, false, "test"); std::vector<double> v(500, 0.97); // Creates 500 copies of the provided initializer
  3. Use C++11 “uniform init” syntax (“{}” without ‘=’) only when neither of the above work: class C { public: explicit C(bool b) { ... }; ... }; class UsesC { ... private: C c{true}; // Cannot use '=' since C() is explicit (and "()" is invalid syntax here) }; class Vexing { public: explicit Vexing(const std::string& s) { ... }; ... }; void func() { Vexing v{std::string()}; // Using "()" here triggers "most vexing parse"; // "{}" is arguably more readable than "(())" ... }
  4. Never mix uniform init syntax with auto, since what it deduces is unlikely to be what was intended: auto x{1}; // Until C++17, decltype(x) is std::initializer_list<int>, not int!

Initialize members in the declaration where possible

If possible, initialize class members in their declarations, except where a member's value is explicitly set by every constructor.

This reduces the chance of uninitialized variables, documents default values in the declaration, and increases the number of constructors that can use =default (see below).

class C {
 public:
  C() : a_(2) {}
  C(int b) : a_(1), b_(b) {}

 private:
  int a_;          // Not necessary to init this since all constructors set it.
  int b_ = 0;      // Not all constructors set this.
  std::string c_;  // No initializer needed due to string's default constructor.
  base::WeakPtrFactory<C> factory_{this};
                   // {} allows calling of explicit constructors.
};

Note that it's possible to call functions or pass this and other expressions in initializers, so even some complex initializations can be done in the declaration.

Use std::make_unique and base::MakeRefCounted instead of bare new

When possible, avoid bare new by using std::make_unique<T>(...) and base::MakeRefCounted<T>(...):

// BAD: bare call to new; for refcounted types, not compatible with one-based
// refcounting.
return base::WrapUnique(new T(1, 2, 3));
return base::WrapRefCounted(new T(1, 2, 3));

// BAD: same as the above, plus mentions type names twice.
std::unique_ptr<T> t(new T(1, 2, 3));
base::scoped_refptr<T> t(new T(1, 2, 3));
return std::unique_ptr<T>(new T(1, 2, 3));
return base::scoped_refptr<T>(new T(1, 2, 3));

// OK, but verbose: type name still mentioned twice.
std::unique_ptr<T> t = std::make_unique<T>(1, 2, 3);
base::scoped_refptr<T> t = base::MakeRefCounted<T>(1, 2, 3);

// GOOD; make_unique<>/MakeRefCounted<> are clear enough indicators of the
// returned type.
auto t = std::make_unique<T>(1, 2, 3);
auto t = base::MakeRefCounted<T>(1, 2, 3);
return std::make_unique<T>(1, 2, 3);
return base::MakeRefCounted<T>(1, 2, 3);

Notes:

  1. Never friend std::make_unique to work around constructor access restrictions. It will allow anyone to construct the class. Use base::WrapUnique in this case. DON'T: class Bad { public: std::unique_ptr<Bad> Create() { return std::make_unique<Bad>(); } // ... private: Bad(); // ... friend std::unique_ptr<Bad> std::make_unique<Bad>(); // Lost access control }; DO: class Okay { public: // For explanatory purposes. If Create() adds no value, it is better just // to have a public constructor instead. std::unique_ptr<Okay> Create() { return base::WrapUnique(new Okay()); } // ... private: Okay(); // ... };
  2. base::WrapUnique(new Foo) and base::WrapUnique(new Foo()) mean something different if Foo does not have a user-defined constructor. Don‘t make future maintainers guess whether you left off the ‘()’ on purpose. Use std::make_unique<Foo>() instead. If you’re intentionally leaving off the “()” as an optimization, please leave a comment. auto a = base::WrapUnique(new A); // BAD: "()" omitted intentionally? auto a = std::make_unique<A>(); // GOOD // "()" intentionally omitted to avoid unnecessary zero-initialization. // base::WrapUnique() does the wrong thing for array pointers. auto array = std::unique_ptr<A[]>(new A[size]);

See also TOTW 126.

Do not use auto to deduce a raw pointer

Do not use auto when the type would be deduced to be a pointer type; this can cause confusion. Instead, specify the “pointer” part outside of auto:

auto item = new Item();  // BAD: auto deduces to Item*, type of `item` is Item*
auto* item = new Item(); // GOOD: auto deduces to Item, type of `item` is Item*

Use const correctly

For safety and simplicity, don't return pointers or references to non-const objects from const methods. Within that constraint, mark methods as const where possible. Avoid const_cast to remove const, except when implementing non-const getters in terms of const getters.

For more information, see Using Const Correctly.

Prefer to use =default

Use =default to define special member functions where possible, even if the default implementation is just {}. Be careful when defaulting move operations. Moved-from objects must be in a valid but unspecified state, i.e., they must satisfy the class invariants, and the default implementations may not achieve this.

class Good {
 public:
  // We can, and usually should, provide the default implementation separately
  // from the declaration.
  Good();

  // Use =default here for consistency, even though the implementation is {}.
  ~Good() = default;
  Good(const Good& other) = default;

 private:
  std::vector<int> v_;
};

Good::Good() = default;

Comment style

References to code in comments should be wrapped in ` ` pairs. Codesearch uses this as a heuristic for finding C++ symbols in comments and generating cross-references for that symbol.

  • Class and type names: `FooClass`.
  • Function names: `FooFunction()`. The trailing parens disambiguate against class names, and occasionally, English words.
  • Variable names: `foo_var`. Historically, Chrome also used || pairs to delimit variable names; codesearch understands both conventions and will generate a cross-reference either way.
  • Tracking comments for future improvements: // TODO(crbug.com/12345): ..., or, less optimally, // TODO(knowledgeable_username): .... Tracking bugs provide space to give background context and current status; a username might at least provide a starting point for asking about an issue.
// `FooImpl` implements the `FooBase` class.
// `FooFunction()` modifies `foo_member_`.
// TODO(crbug.com/1): Rename things to something more descriptive than "foo".

Named namespaces

Named namespaces are discouraged in top-level embedders (e.g., chrome/). See this thread for background and discussion.

原文链接:https://chromium.googlesource.com/chromium/src/+/HEAD/styleguide/c++/c++-dos-and-donts.md

原文作者:Google

我来说两句

0 条评论
登录 后参与评论

相关文章

  • The Dos and Don'ts for Ceph for OpenStack

    Ceph和OpenStack是一个非常有用和非常受欢迎的组合。 不过,部署Ceph / OpenStack经常会有一些容易避免的缺点 - 我们将帮助你解决它们

    用户2772802
  • RTS : The Do's and Don’ts of Java Strings

    问题1: 文章说,大量 String + 连接比 通过 相应的StringBuilder 连接慢,要是在 Java7 之前我信,可以在 Java8 以及之后,...

    shengjk1
  • MSYS2下:unix路径和window路径之间的转换

    今天在写MYSYS2下的脚本(bash shell)遇到一个问题:MSYS2环境下获取到的路径都是’/'开头的unix路径,需要把它转为’C:\Windows\...

    用户1148648
  • Linux 磁盘分区、格式化、目录挂载

    实验环境: Citrix虚拟化, RHEL6.4系统环境 本文目的: 熟悉Linux的基本磁盘分区、格式化、目录挂载。

    Alfred Zhao
  • ubuntu-16.04使用MDK3攻击wifi热点

    MDK3 是一款无线DOS 攻击测试工具,能够发起Beacon Flood、Authentication DoS、Deauthentication/Disass...

    用户4231702
  • linux 命令中英文对照,收集

    听说markdown排版得用浏览器打开,点击最下面的阅读原文也可以! Is Linux CLI case-sensitive? The answer is, y...

    生信技能树
  • 汇编语言关于2号功能函数的坑点

    也可以参考如下文章: http://www.delorie.com/djgpp/doc/rbinter/id/65/25.html

    KevinBruce
  • Linux渗透之Shellshock后门

    注意:本文分享给安全从业人员,网站开发人员和运维人员在日常工作中使用和防范恶意攻击,请勿恶意使用下面描述技术进行非法操作。

    WeiyiGeek
  • KVM 操作虚拟机常用命令

    管理kvm虚拟机 常用的虚拟机管理命令 列出所有的虚拟机 virsh list --all 显示虚拟机信息 virsh dominfo kvm-1 显示虚...

    shaonbean

扫码关注云+社区

领取腾讯云代金券