Thanks for official guide, but of course, I did come from other languages first (like Python, JavaScript, Java).
I am also looking for Doctest (originally in Python, and may be adaptable in some other languages.) - reddit.com/r/golang/comments/bafug...
For references,
Python "Google style" docstring.
def checksum(data: Union[str, bytes]) -> str: """[summary] Args: data (Union[str, bytes]): [description] Returns: str: [description] """ if isinstance(data, str): data = data.encode("utf-8") return sha1(data).hexdigest()
def ankiconnect(action: str, **params): """[summary] Args: action (str): [description] Raises: Exception: [description] Exception: [description] Exception: [description] Exception: [description] Returns: [type]: [description] """
JavaScript JSDoc / TypeScript TSDoc (which is almost similar to JavaDoc).
Again, I am looking to write Documentations that don't lose any information I wanted, not really that "Just following recommendations".
Let me complain this again...
Are you sure you want to hide this comment? It will become hidden in your post, but will still be visible via the comment's permalink.
Hide child comments as well
Confirm
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
Thanks for official guide, but of course, I did come from other languages first (like Python, JavaScript, Java).
I am also looking for Doctest (originally in Python, and may be adaptable in some other languages.) - reddit.com/r/golang/comments/bafug...
For references,
Python "Google style" docstring.
JavaScript JSDoc / TypeScript TSDoc (which is almost similar to JavaDoc).
Again, I am looking to write Documentations that don't lose any information I wanted, not really that "Just following recommendations".
Let me complain this again...
How can I learn to like Golang? (and use it a lot)
Pacharapol Withayasakpunt ・ May 30 ・ 1 min read