golint thinks "/*" contains a trailing space

[dgryski]

Running golint over code like:

/* Package foo does some stuff

Extra notes about foo that I want in the godoc
*/
package foo

generates the warning:

 package comment should not have leading space

Changing it to

/*Package foo ...

"solves" the problem but looks ugly.

Another workaround is to use

// Package foo does some stufff
/* Extra notes about foo I want in the godoc
*/
package foo

but neither of these are suggested. Perhaps a better comment or check should be "Package comment should start with //"

[aclissold]

I was going to suggest simply writing

/*
Package foo does some stuff

Extra notes about foo that I want in the godoc
*/

as that avoids the problem (and isn't ugly in my opinion), but trying it out on an example in the Go source actually causes the same "leading space" error to occur because they indented it. Interesting!

[dsymonds]

The form that ajclisso posted is the standard style for package and doc comments using /* */. testdata/pkg-doc3.go in this repository checks for that.

The standard library is not perfect, and that's okay.