x/tools/godoc: does not print comments accompanying variable literals

[stapelberg]

Take the following example code:

package exported

var IPs = []string{
"127.0.0.1", // localhost

// IPv6 localhost
"::1",
}

…and render it using godoc:

% go get -u golang.org/x/tools/cmd/godoc
% go get -u github.com/stapelberg/godoc-exported
% godoc -http=localhost:6060
% google-chrome http://localhost:6060/pkg/github.com/stapelberg/godoc-exported/

You’ll see:

I.e., the comments are not printed.

I’m guessing this is a consequence of go/ast’s comment handling being tricky. I tried taking a stab at it, but couldn’t get very far, so I figured I’d file a bug and see if someone more familiar with the code can advise what needs to be done here.

[stapelberg]

This also affects godoc.org: https://godoc.org/github.com/stapelberg/godoc-exported

[agnivade]

I think this has been raised before in the past, but I couldn't find an exact issue for this. Maybe #20744 ?

@griesemer

[griesemer]

#20744 is a catch-all issue for all these but it's not godoc specific. We're aware of the issue but we need to resolve #20744 first which is a significant project to get right. Unfortunately it's not high priority at the moment.

[julieqiu]

/cc @dmitshur

[seankhliao]

Duplicate of #6917