Add guidance to style guide how to reference a bug in a TODO

Bug: None
Change-Id: Icfbce347d0c2a71fd728507e5005eb05736b13a1
No-Try: True
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/161733
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Commit-Queue: Danil Chapovalov <danilchap@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#30058}
This commit is contained in:
Danil Chapovalov 2019-12-11 12:45:08 +01:00 committed by Commit Bot
parent 3c4fda2ed8
commit 375eff4f04

View File

@ -61,6 +61,16 @@ declare.
[Examples and exceptions](style-guide/h-cc-pairs.md).
### TODO comments
Follow the [Google style][goog-style-todo]. When referencing a WebRTC bug,
prefer the url form, e.g.
```
// TODO(bugs.webrtc.org/12345): Delete the hack when blocking bugs are resolved.
```
[goog-style-todo]: https://google.github.io/styleguide/cppguide.html#TODO_Comments
### ArrayView
When passing an array of values to a function, use `rtc::ArrayView`