mollyim/webrtc
1
0
Fork 0
mirror of https://github.com/mollyim/webrtc.git synced 2025-05-12 13:20:44 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Recommend to follow C++ tips of the week in webrtc c++ style guide

Browse source 
Link c++ tips of the week as best practices for better discoverability.
Extend deprecated section with recommendation to use recently published ABSL_DEPRECATE_AND_INLINE macro.

No-Try: True
Bug: None
Change-Id: I3336e5929ae31542ff12ef6b1dfd9c272b9c480a
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/347743
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Commit-Queue: Danil Chapovalov <danilchap@webrtc.org>
Cr-Commit-Position: refs/heads/main@{#42100}
This commit is contained in:
Danil Chapovalov 2024-04-17 15:01:40 +02:00 committed by WebRTC LUCI CQ
parent 93453f5b19
commit 85bea5a11b
1 changed files with 19 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
g3doc/style-guide.md
View file

@ -1,5 +1,5 @@
<!-- go/cmark -->
<!--* freshness: {owner: 'danilchap' reviewed: '2022-01-17'} *-->
<!--* freshness: {owner: 'danilchap' reviewed: '2024-04-17'} *-->
# WebRTC coding style guide
@ -14,10 +14,12 @@ If making large changes to such code, consider first cleaning it up in a
WebRTC follows the [Chromium C++ style guide][chr-style] and the
[Google C++ style guide][goog-style]. In cases where they conflict, the Chromium
style guide trumps the Google style guide, and the rules in this file trump them
both.
both. In addition to style guides it is recommended to follow
[best practices][goog-best-practice] when applicable.
[chr-style]: https://chromium.googlesource.com/chromium/src/+/main/styleguide/c++/c++.md
[goog-style]: https://google.github.io/styleguide/cppguide.html
[goog-best-practice]: https://abseil.io/tips
### C++ version
@ -84,6 +86,17 @@ Like so:
std::pony PonyPlz(const std::pony_spec& ps);
```
Prefer [ABSL_DEPRECATE_AND_INLINE] to deprecate an inline function definition
or a type alias. This macro allows to automate inlining the functions's body or
replacing the type where it is used downstream. e.g.,
```cpp
ABSL_DEPRECATE_AND_INLINE() inline int OldFunc(int x) {
return NewFunc(x, 0);
}
using OldTypeName ABSL_DEPRECATE_AND_INLINE() = NewTypeName;
```
NOTE 1: The annotation goes on the declaration in the `.h` file, not the
definition in the `.cc` file!
@ -109,6 +122,7 @@ readable way.
[DEPRECATED]: https://en.cppreference.com/w/cpp/language/attributes/deprecated
[ABSL_DEPRECATED]: https://source.chromium.org/chromium/chromium/src/+/main:third_party/abseil-cpp/absl/base/attributes.h?q=ABSL_DEPRECATED
[ABSL_DEPRECATE_AND_INLINE]: https://source.chromium.org/chromium/chromium/src/+/main:third_party/abseil-cpp/absl/base/macros.h?q=ABSL_DEPRECATE_AND_INLINE
### ArrayView
@ -169,7 +183,9 @@ held by the API user, `rtc::scoped_refptr` can be appropriate.
### `std::bind`
Don't use `std::bind`—there are pitfalls, and lambdas are almost as succinct and
already familiar to modern C++ programmers.
already familiar to modern C++ programmers. See [Avoid std::bind][totw-108] for more.
[totw-108]: https://abseil.io/tips/108
### `std::function`