From: Simon Marchi via Gdb-patches <gdb-patches@sourceware.org>
To: Simon Marchi via Gdb-patches <gdb-patches@sourceware.org>
Subject: Coding standards proposal, usage of "this"
Date: Fri, 13 Aug 2021 10:26:48 -0400 [thread overview]
Message-ID: <c99dc37f-a968-3374-94ff-3536b7f220ef@polymtl.ca> (raw)
Hi all,
Here's something I had in mind for a while. We don't consistently use
`this` when referring to fields or methods of the current object. I
never now if I should use it or not, or point it out in review. I
therefore propose these rules so that we have something to refer to.
- Use `this` when referring to a data member that is not prefixed by
`m_`. Rationale: without `this`, it's not clear that you are
referring to a member of the current class, versus a local or global
variable.
- Don't use `this` when referring to a data member that is prefixed by
`m_`. Rationale: the prefix already makes it clear that you are
referring to a member of the current class, so adding `this` would
just add noise.
- Use `this` when referring to a method of the current class.
Rationale: without `this, it's not clear that you are referring to a
method of the current class, versus a free function.
If we had a convention for how to name internal helper methods, which
would make it clear that they are methods of the current object and not
free functions (a bit like `m_` does for data members), we could omit
`this` when calling such a method. But we don't have that at the
moment.
A concrete example:
int a_global;
struct a_struct
{
int a_method ()
{
int a_local = 17;
return (a_local
+ a_global
+ m_a_private_field
+ this->a_public_field
+ this->a_helper_method ());
}
int a_public_field;
private:
int a_helper_method ()
{
return m_a_private_field;
}
int m_a_private_field;
};
Any comments? My intention would be to add this to the coding standards
on the wiki.
Simon
next reply other threads:[~2021-08-13 14:27 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-13 14:26 Simon Marchi via Gdb-patches [this message]
2021-08-13 14:46 ` Paul Koning via Gdb-patches
2021-08-13 14:51 ` Simon Marchi via Gdb-patches
2021-08-13 14:47 ` Andrew Burgess
2021-08-15 13:34 ` Lancelot SIX via Gdb-patches
2021-08-16 16:40 ` Christian Biesinger via Gdb-patches
2021-08-16 16:59 ` Simon Marchi via Gdb-patches
2021-08-18 11:43 ` Ruslan Kabatsayev via Gdb-patches
2021-08-16 17:06 ` John Baldwin
2021-08-16 17:11 ` Simon Marchi via Gdb-patches
2021-08-16 17:23 ` Luis Machado via Gdb-patches
2021-08-16 17:31 ` Simon Marchi via Gdb-patches
2021-08-17 10:01 ` Andrew Burgess
2021-08-16 17:28 ` John Baldwin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=c99dc37f-a968-3374-94ff-3536b7f220ef@polymtl.ca \
--to=gdb-patches@sourceware.org \
--cc=simon.marchi@polymtl.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox