How to link to a function when documenting the code.

[Nguyên Nguyễn Văn Cao]

I mean a click able link on the comment. For example, the comment for Foo function:

Foo do something that similar with Bar.

How can I make "Bar" click able? I don't think we can use HTML in the comment, so an change to make it auto-link just like what we does with the agrs list?

[Christoph Hack]

The godoc tool currently does not support any kind of markup. Writing good documentation is already difficult enough without custom markup languages.

[Hotei]

You can create an example for any function.  Don't know if that's sufficient for your issue but it's relatively easy and ends up in the godoc output without cluttering your main code.

[Andrew Gerrand]

Here's a feature request (by me) for turning names like "package foo" in documentation to links to "/pkg/foo/", should it exist.

https://code.google.com/p/go/issues/detail?id=4953

The same could be done for "function Bar", "method Bar.Quux", "type Boing", etc.

Andrew

[Nguyên Nguyễn Văn Cao]

How do you think about link them to godoc.org?

Vào 02:58:43 UTC+7 Thứ hai, ngày 06 tháng năm năm 2013, Andrew Gerrand đã viết: