How to write Godoc?

These pretty much says it.

• https://github.com/aws/aws-sdk-go/blob/master/aws/types.go#L23
• https://godoc.org/github.com/aws/aws-sdk-go/aws#LogLevelType

In short, starting with a sentence with Function name as first noun. Markdown might also be supported. (At least for hyperlinks, and)

    // to `nil` or the value to `""` to use the default generated endpoint.
    //
    // Note: You must still provide a `Region` value when specifying an

Nothing near the level of JSDoc, JavaDoc, or several of Python docstring conventions, though; where Arguments and Returns, as well as Errors, are documented. Also, syntax highlighting for JSDoc/JavaDoc are far superior (with @annotation).

Comments

[Swastik Baranwal]

I refer to this

[Pacharapol Withayasakpunt]

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...

How can I learn to like Golang? (and use it a lot)

Pacharapol Withayasakpunt ・ May 30 ・ 1 min read

#go #help