Design-Patterns icon indicating copy to clipboard operation
Design-Patterns copied to clipboard

Add a description to what the design patterns are and what they try to achieve

Open Venthe opened this issue 6 years ago • 3 comments

Venthe avatar Feb 06 '19 07:02 Venthe

@Venthe I think it would be good if there was a README.md to go together with each example. That way you could get a idea of what the pattern is supposed to accomplish before diving into the code.

Are you taking pull-requests? I´d be up for expanding on the singleton example.

JC-85 avatar Feb 06 '19 17:02 JC-85

I sure do; though I think that it should be in code. What do you think?

Venthe avatar Feb 06 '19 18:02 Venthe

I think the implementation should be commented through-out with explanations on each step. You could also preface every class with a description of its purpose. But each pattern should also be accompanied by an explanation of the theory behind the pattern. I got a pull request ready with how I would mange it, but feel free to reject it if it doesn't fit your taste.

JC-85 avatar Feb 06 '19 20:02 JC-85