Programming

17538 readers

67 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Follow the programming.dev instance rules
Keep content related to programming in some way
If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 2 years ago

MODERATORS

snowe

Ategon

[email protected]

[Help] Any FOSS or at least privacy friendly AI tool to automatically comment code? (lm.helilot.com)

submitted 1 year ago* (last edited 1 year ago) by [email protected] to c/programming

9 comments fedilink hide all child comments

I used Trelent, an extension for VS code that didn't require any registration, but their server has been unresponsive for a while. Any alternative you would recommend?
My code is in Python, mostly.

Edit: I wasn't clear on my intention. I was looking for a tool that would lay out a generic description so I would start from something and fine tune the explanation.
I am incredibly bad at documenting, the process is tedious and frustrating. At the end of the day, my explanations are mostly gibberish anyway.
From your general consensus, I should bite the bullet and do it by myself.
I really appreciate your feedback, point taken. Time to psych myself up with some death metal and get it over with.

you are viewing a single comment's thread
view the rest of the comments

[–] sirdorius 11 points 1 year ago (1 children)

Wow, the examples of Trelent are so incredibly useless. If you're going to generate comments like that, just don't. It is a waste of time to go through it as it is obvious from the function signature. And anything that could probably be written to be useful in the comment can't be grasped by LLM. LLMs just add padding to data, they add no content.

[–] [email protected] 8 points 1 year ago (1 children)

yeah, any comment that can be auto-generated doesn't need to be there in the first place. The real issue might be overly-dogmatic comment/docstring requirements

[–] mrkite 7 points 1 year ago

Even worse. Auto generated comments just copy the how and not the why. If the code has a bug so does the comment.. and if you fix the bug but not the comment somebody else might change the code back to match the comment.