Ability to add private documentation to references

[arp242]

Right now all the godoc comments for references are added to the Kommentaar output. Sometimes it might be useful to have just some internal/private notes.

I can't really think of an elegant way of doing that. Only way I can think of is something along the lines of:

// Foo is a bar.
//
// {private}
// Not in Kommentaar output.
type Foo struct {
    // Public stuff.
    //
    // {private}
    // This is not in the Kommentaar output.
    Name
}

but I can't say I'm especially impressed by that. Alternatives to {private} might be ---, or something else.

Need to think about it. Suggestions welcome.

[ripexz]

Could do //- rather than // for lines that should not be public? 🤔
At least that's what Pug does - // get rendered as HTML comments whereas //- don't 😊

So something like

// Foo is a bar.
//
//- Not in Kommentaar output.
type Foo struct {
    // Public stuff.
    //
    //- This is not in the Kommentaar output.
    // This is in Kommentaar output again.
    Name string
}

[arp242]

Maybe; but it looks kinda meh in godoc though, especially with multiple lines on the struct.

[arp242]

A simple "private" keyword is probably best:

// Foo is a bar.
//
// private: This documentation is private.
// And will not be added
// to Kommentaar.
type Foo struct {
	// Public stuff.
	//
	// private: This is not in the Kommentaar output.
	// but is private.
	// Good stuff!
	Name string
}

[ripexz]

I don't mind either way, was just a suggestion 😄