Skip to content

doc: formalize non-const reference usage in C++ style guide #23155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
addaleax wants to merge 5 commits into from
Closed

doc: formalize non-const reference usage in C++ style guide #23155

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
73139a5
doc: formalize non-const reference usage in C++ style guide
addaleax Sep 22, 2018
8daa18e
squash! doc: formalize non-const reference usage in C++ style guide
addaleax Oct 1, 2018
e9f8406
fixup! squash! doc: formalize non-const reference usage in C++ style …
addaleax Oct 1, 2018
acba30d
fixup! fixup! squash! doc: formalize non-const reference usage in C++…
addaleax Oct 2, 2018
04f941a
fixup! fixup! fixup! squash! doc: formalize non-const reference usage…
addaleax Oct 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup! squash! doc: formalize non-const reference usage in C++ style … 
…guide
  • Loading branch information
@addaleax
addaleax committed Oct 1, 2018
commit e9f84067b623a056faa8ddb43290754450df1b09
7 changes: 5 additions & 2 deletions CPP_STYLE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ assignment. A pointer is almost always a better choice.
```c++
class ExampleClass {
public:
explicit ExampleClass(int* int_ptr) : pointer_to_integer_(int_ptr) {}
explicit ExampleClass(OtherClass* other_ptr) : pointer_to_other_(other_ptr) {}

void SomeMethod(const std::string& input_param,
std::string* in_out_param); // Pointer instead of reference
Expand All @@ -230,7 +230,10 @@ class ExampleClass {

private:
std::string foo_string_;
int* pointer_to_integer_; // Pointer instead of reference.
// Pointer instead of reference. If this objects 'owns' the other object,
Copy link
Copy Markdown
Contributor

@thefourtheye thefourtheye Oct 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: object

Copy link
Copy Markdown
Member Author

@addaleax addaleax Oct 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thefourtheye Thanks for catching, done!

// this should be be a `std::unique_ptr<OtherClass>`; a
Copy link
Copy Markdown
Contributor

@thefourtheye thefourtheye Oct 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: double be

// `std::shared_ptr<OtherClass>` can also be a better choice.
OtherClass* pointer_to_other_;
};
```

Expand Down