search

StefanKert / BuildVision

A Visual Studio extension to visualize the building process.
MIT License
261 stars 43 forks source link

.editorconfig added to help during development to stick to a style #49

Closed binaryn3xus closed 6 years ago

binaryn3xus commented 6 years ago

In response to Issue #48, I have added a .EditorConfig file to help normalize the coding style within the project.

StefanKert commented 6 years ago

Looks good to me, fixed some smaller issues. Thanks!!

JohnyWS commented 6 years ago

It might just be me, but the code is a whole lot easier to read on e.g. github if you change the 3rd var rule to false (csharp_style_var_elsewhere), because then you can read the class without having a parser tell you (through hovering over var) or by finding the method you are calling, to see what it returns.

StefanKert commented 6 years ago

@JohnyWS fair point. IMHO we should name variables properly. If we do so, the name should be implicit and there should be no need for not using var. In fact, if the name fits well there is no need for the type, right? But I am open for points, if you like you can open an issue for discussing the styling conventions for BuildVision. Do not have a really strong opinion on most of this guidelines. The settings that @JoshuaGarrison27 committed are basically the default coding conventions from Microsoft, but as I mentioned earlier, I am open for changes :)

JohnyWS commented 6 years ago

@StefanKert no reason using a lot of time on that. The possible overhead the code could have on miniscule suboptimal convetions, is not worth long discussions on conventions, because those typically get longwinded. ;) The settings are fine as they are, just wanted to point it out, because it is a rather new feature that I like. :) - About the not needing the type, I do not agree though, because the variable should not include info about the type, only what it does or is used for. Minor details in different implementations is why the class is good to know, but since for most purposes only one class fits, it seldom is an issue. :)