golang / go

The Go programming language
https://go.dev
BSD 3-Clause "New" or "Revised" License
123.99k stars 17.67k forks source link

Suggestion:godoc should generate java style doc(I mean ui layout) #4118

Closed gopherbot closed 9 years ago

gopherbot commented 12 years ago

by Alexander.Luya:

Please check here:http://docs.oracle.com/javase/6/docs/api/
Its layout 
Left:   up: packages         down:structs and functions
Right:  struct and function details

And comment tag should be considered also.
Please check
here:http://docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#javadoctags

I think this won't take so much time of you guys,but save huge time of users.
cznic commented 12 years ago

Comment 1:

Please no.
gopherbot commented 12 years ago

Comment 2 by Alexander.Luya:

And linking should be considered also,when click a class name,user should be linked to
the doc of this class
Another more difficlut function is listing parents and children.For example,when you
check Map interface in java api doc,you will be given all Known Subinterfaces and all
Known Implementing Classes
gopherbot commented 12 years ago

Comment 3 by Alexander.Luya:

0xj,Can you give reasons?
gopherbot commented 12 years ago

Comment 4 by Alexander.Luya:

And linking should be considered also,when clicking a struct or function name,user
should be led to the doc of them
Another more difficlut function is listing parents and children.For example,when you
check Map interface in java api doc,you will be given all Known Subinterfaces and all
Known Implementing Classes
fsouza commented 12 years ago

Comment 5:

There's no subinterfaces nor parents in    Go.
For links, there's already a issue.
About using javadoc style docs, it does not make swnse. What do you don't like in the
current godoc format? Why don't you point out some changes instead of suggesting a full
layout/style change?
robpike commented 12 years ago

Comment 6:

The javadoc style suits Java but not Go. It's about showing you the type hierarchy,
which isn't even a concept in Go.
Also it was a deliberate decision to eliminate markup from the comments that become the
documentation for godoc. That way the source reads as well as the documentation.
robpike commented 12 years ago

Comment 7:

Status changed to WorkingAsIntended.

gopherbot commented 12 years ago

Comment 8 by Alexander.Luya:

franciscossouza:
Because this layout is far more using friendly:
-------------------------------------------------------------
Left:   up: packages         down:structs and functions
Right:  struct and function details
-------------------------------------------------------------
user won't need to "jump up and down",saving a lot of scrolling actions.
for this:
.....
About using javadoc style docs, it does not make swnse. What do you don't like in the
current godoc format? Why don't you point out some changes instead of suggesting a full
layout/style change?
......
It isn't about like or dislike but reasoning.If you take it as an algorithm,java's doc
style(think is as a data data structure) saves a lot of "disk Seek Time".
gopherbot commented 12 years ago

Comment 9 by Alexander.Luya:

franciscossouza:
Because this layout is far more user friendly:
-------------------------------------------------------------
Left:   up: packages         down:structs and functions
Right:  struct and function details
-------------------------------------------------------------
user won't need to "jump up and down",saving a lot of scrolling actions.
for this:
.....
About using javadoc style docs, it does not make swnse. What do you don't like in the
current godoc format? Why don't you point out some changes instead of suggesting a full
layout/style change?
......
It isn't about like or dislike but reasoning.If you take it as an algorithm,java's doc
style(think is as a data data structure) saves a lot of "disk Seek Time".