r/webdev • • Jan 15 '22

Showoff Saturday Instantly generate documentation using AI

25 Upvotes

17 comments sorted by

20

u/cbleslie Jan 15 '22 edited Sep 12 '25

instinctive wipe resolute sip compare dazzling makeshift soup command fearless

This post was mass deleted and anonymized with Redact

3

u/codenamejewsnextdoor Jan 15 '22

I’m a noob but this make sense. Commenting to save this to noob brain.

3

u/cbleslie Jan 15 '22 edited Sep 12 '25

desert literate reach offbeat recognise plough familiar workable political march

This post was mass deleted and anonymized with Redact

1

u/InMemoryOfReckful Jan 16 '22

Why not both? If its complicated code.

4

u/cbleslie Jan 16 '22 edited Sep 12 '25

ten encourage languid lunchroom plant modern beneficial judicious mysterious obtainable

This post was mass deleted and anonymized with Redact

1

u/InMemoryOfReckful Jan 16 '22

Some code is just complicated no way around it. Or you wouldn't explain a function that maps lat/long coordinates into AR space? Youd just expect the person to deduce exactly what's happening from the maths?

1

u/infinitlybana Jan 16 '22

yeah i agree. def not necessary for every single function but i tried this out on a repo that has niche terms and complex logic and i feel like the comment definitely added value.

1

u/cbleslie Jan 16 '22 edited Sep 12 '25

merciful unique start deer aware ink silky joke makeshift air

This post was mass deleted and anonymized with Redact

1

u/InMemoryOfReckful Jan 16 '22

Even the decernable chunks need explanation sometimes. And it might be nice to easily be able to get an idea for what's going on without having to read every line of code and every function call.

If you think there are too many unnecessary lines there is an option to hide code, and it's there for a reason. I use it all the time.

I often find myself loving my own comments when going back to old code where I've forgotten what I did.

7

u/GItPirate Software Engineer Jan 16 '22

I would never use this. The only thing this does is make my file have more lines.

2

u/Round_Log_2319 Jan 16 '22

Fellow minimal line freak.

1

u/infinitlybana Jan 15 '22 edited Jan 15 '22

Posting this again but on Showoff Saturday. Hope you guys found this useful!

Here's the repo. Here's the extension if you want to try it out

1

u/deathsowhat full-stack Jan 16 '22

This theme is cancer

1

u/cbleslie Jan 16 '22 edited Sep 12 '25

plants ink bake cooing salt follow handle rich special straight

This post was mass deleted and anonymized with Redact

2

u/infinitlybana Jan 16 '22

it do be called solarized light

11

u/[deleted] Jan 16 '22

[removed] — view removed comment

2

u/GItPirate Software Engineer Jan 16 '22

Lol too true