search

alexwalterbos / image-reconstruction

Neural Network seminar image reconstruction project
0 stars 0 forks source link

Install StyleCop and Guidelines #16

Open festen opened 10 years ago

festen commented 10 years ago

I suggest you both install StyleCop. This ensures that we all work with the same coding standards. I've already included style cop settings files for our projects, so it should work right away. What it does is give warnings for style errors you make (typo's, commented out code, undocumented functions, etc.)

What I also did is stay within 80 columns, this drastically improves readability. To do this, you can install GuideLines at Tools > Extensions and Updates > Online Then search for Guidelines in search box and install Editor Guidelines.

Now it's possible to add a guidelines using the context menu in the editor. (you can change it's color to be barely visible, so that it doesn't distract you so much.

festen commented 10 years ago

screenshot This is what my editor looks like. I intentionally deleted one of the documentation headers so that you can see the style cop warning.