Skip to content

My sample code and the mess of comments

Today I was asked why I comment so much in my samples, and the Gist that I publish here.

The answer is very easy: The comments should educate everyone a bit (more)!

I know that there are a lot of redundancies and that not every comment makes perfect sense.

A lot of the samples are part of my workshops and showcases. How should I teach others how to write Scripts and build their own tools of the code is not documented well?

Two quotes to think about:

The sourcecode is documentation enough. Unknown developer

It was hard to write the code, so it must be hard to read it! Unknown developer

And to be honest: I think if the comments are too much, just remove them!

This content is older than 2 years. It might be outdated.
Published inHowToPowerShell

Be First to Comment

Leave a Reply

Your email address will not be published. Required fields are marked *

Copyright © 2018 by Joerg Hochwald. All rights reserved. ● Site is powered by Author