The godoc format enforces that the comment start with the name of the identifier and be a complete sentence(s) describing what that identifier does. Predates LLMs
replyI wouldn't say it enforces that the comment start with the name of the identifier. Maybe certain linter options enforce that?
replyIn https://go.dev/doc/comment it seems to be a convention, but there are a couple of examples there where the don't follow it.
Yeah some times godoc comments look crap by necessity
replyBut you don't have to add a docstring. Cases like this are worse than no docstring at all, because it wastes the reader's time.
replyIf you add one, at least make the effort to provide some useful information. For example which is more severe: higher or lower numbers.
Every public item should have a docstring, even if it's just to indicate that there's nothing special about the item.
replyI disagree - you should have docstring and I don't think this is worse by having it... its just not ideal
replyBoilerplate docstrings are lint that spreads, and stale ones are worse, I've seen sevreity fields documented less clearly than the code they annotate.
reply