// comments instead of /* .. */ about language-go HOT 11 CLOSED

👍 Where's the PR @drnic?

from language-go.

Want to know if it's ok or if authors have some overriding preference.

On Sat, Apr 26, 2014 at 2:35 PM, Joe Fitzgerald [email protected]
wrote:

👍 Where's the PR @drnic?

Reply to this email directly or view it on GitHub:
#16 (comment)

from language-go.

I'm fine trusting interested Go users on this one.

from language-go.

@drnic Pull request to 🚀 please – this is bugging me also.

from language-go.

Further references supporting the desire to prefer // over /* ... */:

• http://blog.golang.org/godoc-documenting-go-code
• https://code.google.com/p/go-wiki/wiki/CodeReviewComments
• http://golang.org/doc/effective_go.html#commentary

In summary, it the vast majority of your comments are likely to be line-style. Block-style comments may occasionally be seen in package comments, but even then only in non-trivial packages (likely with examples).

Consequently, // would be preferable as it is most commonly used, and it would be nice if we had another keyboard shortcut for /* ... */?

from language-go.

@nathansobo I'm looking across a couple of packages - not sure what it is that defines the comment type for Cmd+/ - can you point me to some examples?

from language-go.

@drnic @nathansobo https://github.com/atom/language-go/blob/master/grammars/go.cson#L300-L324?

from language-go.

@drnic @nathansobo plus this: https://github.com/atom/language-go/blob/master/grammars/go.cson#L11-L15 ?

from language-go.

I think that's just defining that /* ... */ is a valid multi-level comment
syntax. Not that Cmd+/ toggles comment.

On Mon, Apr 28, 2014 at 9:50 AM, Joe Fitzgerald [email protected]:

@drnic https://github.com/drnic @nathansobohttps://github.com/nathansobo
https://github.com/atom/language-go/blob/master/grammars/go.cson#L300-L324
?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/16#issuecomment-41582914
.

Dr Nic Williams
Stark & Wayne LLC - consultancy for Cloud Foundry users
http://drnicwilliams.com
http://starkandwayne.com
cell +1 (415) 860-2185
twitter @drnic

from language-go.

When you comment the editor wraps the text in <span class="comment block go">...</>. https://github.com/atom/language-go/blob/master/grammars/go.cson#L15 Defines comment.block.empty.go. https://github.com/atom/language-go/blob/master/grammars/go.cson#L308 defines comment.block.go.

from language-go.

@drnic Looks like scoped-properties = deliverance: https://github.com/atom/language-yaml/blob/master/scoped-properties/language-yaml.cson#L3

from language-go.