Code style about zigbeenet HOT 8 CLOSED

For me.. I do not use ReSharper.I would suggest

-using default VS indentions
-always use curly brackets for if statements except for parameter validations
-for parameter validations use one line for the condition and next line with the mentioned indention throwing the exception
-always add xml comments for puplic members
-avoid empty catch blocks or at least leave a comment
-Async postfix for methods returning a Task
-one File per class
-underscore prefix for private attributes
-use private attributes instead of private properties
-order of class members:
private attributes
properties
ctors
public methods
private methods

That's just my opinion.. Comments or additions are welcome

from zigbeenet.

I also don't have ReSharper. But i can agree @nicolaiw sugesstions.

One thing i would prefer, because of better readability:

• use data type on variable declaration instead of var

int a = 1;
int b = 1;

so use:
int c = a + b;
instead of
var c = a + b;

from zigbeenet.

@eiaro Im with you.. MS introduced it to improve readability..but in this case I guess we can benifit of explicte type declarations.. Zigbee is not an easy protocol and when someone tries to contribute it could be helpfull to see the type at the first sight without hover the method to see which type u are get from a method or what else.. Zigbee is not easy so I for my self would also prefer to declare types explicitly instead of using var

from zigbeenet.

For what it's worth, I disagree. In 10 years on the Net platform, I've never heard anyone wishing back to explicit declaration.

If you want contributors to follow your guidelines you must create some sort of style sheet. ReSharper is good, but there is also https://github.com/DotNetAnalyzers/StyleCopAnalyzers

from zigbeenet.

The var statement was introduced in C# 3.0 to improve readability...

I don't argue format, so whatever you decide.

from zigbeenet.

Most time we are reading code. So readability is a fundamental point.

var is good when you are working with Linq for example, but for declaration of variables does not cost more time to write data type, but improves readability

I won't get in discussions but it would be a help if you use implicit type of it is not clear on declaration.

Otherwise it will be OK if you write things like var count = 0 where it is clear which datatype it is

You can read many discussions about var on the internet and only if something was introduced it does not always make sense or improve something

from zigbeenet.

Ok following… because we do not have ReSharper and other Tools at the Moment we can not provide some guidelines at the moment.
Your code isn't bad and it was just a suggestion.

This should not blocks our development, because we have a great software we are working on and i am happy to work with you :-)

This issue is now on-hold

from zigbeenet.

You don't have this in your VS?

Write the settings in a file and name it .editorconfig and it will be applicable for everyone on the project if they work on an editor supporting EditorSettings (most do).

(This is just to show there are options)

from zigbeenet.