Hacker Newsnew | past | comments | ask | show | jobs | submitlogin
How to Write Great Code Documentation: Best Practices and Tools (qodo.ai)
2 points by koala112 11 months ago | hide | past | favorite | 1 comment


This article has strong vibes that it was written by AI :\

> 1. Reduced Code Understandability: Poorly documented code can be difficult to understand, especially for developers new to the project or those revisiting the code after a significant period.

who speaks like that?

Also this type of docs:

    def get_id(self) -> int:
        """
        Get the user's unique identifier.
        Returns:
            - int: The unique identifier of the user.
        """
        return self.id
I know it looks like I'm submitting just to complain, but man




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: