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.
RE your edit: I also support that conclusion and I’m glad you’ll give it a shot yourself. A mindset that helps me is this: commenting is part of the iterative code writing process. When I’m struggling to put a concise and understandable comment above some code, it almost universally means that there’s something about the code itself I should arrange more clearly. This is your chance to do some rubber ducking, it’s valuable to both you and the next person to read your code!
This is gold advice. Thank you.
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.
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
I think the typical approach is in the opposite direction… Write a comment about what the code should do then have the AI write the code, adjusting for any mistakes it makes.
