Added general recommendations #4002
Conversation
docs/style-guide.rst
Outdated
|
|
||
| * Private functions | ||
|
|
||
| It's convention to start private function names with an underscore (`_`). e.g. `_myPrivateFunction` |
There was a problem hiding this comment.
I'm not sure about this. Is any project doing this?
There was a problem hiding this comment.
This is one project: Crypto Zombies
at lesson 1 chapter 9
There was a problem hiding this comment.
There needs to be a bit stronger concensus if we put into the guide claiming it is a convention.
There was a problem hiding this comment.
@axic
They probably took it from the fact that it's a convention in languages like Python, PHP and other OOP languages. However in JS since everything is public, there are some discussions wether to do that or not. Also seen in the React and NPM source code.
But I guess any Styling convention comes down to preference really...
There was a problem hiding this comment.
And exactly because it comes down to preference I would rather not put naming conventions in a styling guide.
There was a problem hiding this comment.
I must say the Function parameter variable names I have seen in many places and do think it's useful. Maybe we can just scratch out the private function name one?
There was a problem hiding this comment.
The convention in python also comes from the fact that you cannot mark members as private (or at least you were not able to in previous versions). I think PHP is similar.
docs/style-guide.rst
Outdated
| TODO | ||
| * Function parameter variable names | ||
|
|
||
| It's convention to start function parameter variable names with an underscore (`_`) in order to differentiate them from global variables. e.g. `function myFunction(_foo, _bar) { }` |
|
I'd rather not add this as a convention, but as a suggestion or guideline. As much as I'm in favor of conventions, I think we should leave this up to the users. |
|
This recommendation conflicts with the other naming conventions, so I fear we have to close this. |
No description provided.