blueprint icon indicating copy to clipboard operation
blueprint copied to clipboard

Generate comments to help educate new uses of design choices

Open jasonmccreary opened this issue 5 years ago • 7 comments

Both Laravel and Blueprint follow some documented, as well as community, conventions. Developers new to Laravel may not be familiar with these.

As such, it'd be nice to have a --notes option which would add the Laravel-style block comments with more information about the generated code with links to the documentation where applicable.

With this we can ensure Blueprint users become familiar with Laravel as well as Blueprint, and vice version.

jasonmccreary avatar Feb 08 '20 22:02 jasonmccreary

Just popping in to say, as a relatively new Laravel developer, anything that can help devs internalize the Laravel approach seems to have tons of spillover benefits. I would def appreciate this option.

gmgarrison avatar Jun 14 '20 16:06 gmgarrison

For sure. This is still on the list. Just trying to manage bugs and a few open issues first. 😅

jasonmccreary avatar Jun 14 '20 18:06 jasonmccreary

@jasonmccreary are there any specific ones that you think would be a good start?

faustbrian avatar May 06 '23 07:05 faustbrian

Not sure. Been so long now. I'd have to get back into it. Probably something I'll do.

jasonmccreary avatar May 06 '23 11:05 jasonmccreary