New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expert Opinion: godoc and godoc.org need a rethink #5107

Closed
gopherbot opened this Issue Mar 22, 2013 · 2 comments

Comments

Projects
None yet
2 participants
@gopherbot

gopherbot commented Mar 22, 2013

by pedromorgan:

Ok ok lets put a nil into things we dont have to do it like

First question for any coder..

Is that all we want to do is explain bits of code, and its runningz what it does..
Hopefully there is a lot of coders looking at it cos we can auto gen documentation..

Now there are a few ways to do this..
The first concept is to..
For the doco manager is to 
create the file that explain and do things and a manual

The nexxt concept is to interlink into stuff

What developers want
? 
NOrmally the developer is do busy coding u have to interupt It whet


I better explain how this works and all langs work different ways
Java
/* Is Documentated
*/
this(


What GoLand should be


Is a simple commentrty and link
Aas we gonna use gomang.org aaas our voerifier..
Si all the comment we spend our tiimes will come into fuitiion


We expectsimple markup eg
/* This IS IT
*/

Its pissing me off bigtimer.. I waanna wrie code
@adg

This comment has been minimized.

Show comment
Hide comment
@adg

adg Mar 22, 2013

Contributor

Comment 1:

This is incomprehensible.

Status changed to Invalid.

Contributor

adg commented Mar 22, 2013

Comment 1:

This is incomprehensible.

Status changed to Invalid.

@adg

This comment has been minimized.

Show comment
Hide comment
@adg

adg Mar 22, 2013

Contributor

Comment 2:

Maybe you should read this?
http://blog.golang.org/2011/03/godoc-documenting-go-code.html
Contributor

adg commented Mar 22, 2013

Comment 2:

Maybe you should read this?
http://blog.golang.org/2011/03/godoc-documenting-go-code.html

@golang golang locked and limited conversation to collaborators Jun 24, 2016

This issue was closed.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.