过度文档化？

[邱焜]

type Image interface {
// ColorModel returns the Image's color model.
ColorModel() color.Model

这不是显然的嘛？

[南海]

如果返回是string等基本类型，我觉得就没必要做注释了！

返回color.Model还是有必要做下注释说明的！

返回color包下面的Model接口

--
官网: http://golang-china.org/
IRC:  irc.freenode.net     #golang-china
@golangchina

[lihui]

如果返回的是string等基本类型，最好是说明一下，因为基本类型没有表达业务意义。

如果是用户定义类型，可以不说明，但对于公共函数和变量，还是说明一下比较好，以利于形成一致的api文档。

2012/6/18 南海 <viney...@gmail.com>

[邱焜]

2012/6/18 南海 <viney...@gmail.com>:
> 如果返回是string等基本类型，我觉得就没必要做注释了！
> 返回color.Model还是有必要做下注释说明的！
> 返回color包下面的Model接口

我的意思是：你这句话和源码表达的不一样嘛？

[xing]

锟斤拷 2012锟斤拷06锟斤拷18锟斤拷 11:39, 锟斤拷j 写锟斤拷:
> 2012/6/18 锟较猴拷 <viney...@gmail.com>:
>> 锟斤拷锟斤拷锟斤拷string锟饺伙拷锟斤拷锟酵ｏ拷锟揭撅拷锟矫撅拷没锟斤拷要锟斤拷注锟斤拷锟剿ｏ拷
>> 锟斤拷锟斤拷color.Model锟斤拷锟斤拷锟叫憋拷要锟斤拷锟斤拷注锟斤拷说锟斤拷锟侥ｏ拷
>> 锟斤拷锟斤拷color锟斤拷锟斤拷锟斤拷锟組odel锟接匡拷
> 锟揭碉拷锟斤拷思锟角ｏ拷锟斤拷锟斤拷浠帮拷锟皆达拷锟斤拷锟侥诧拷一锟斤拷锟斤？
>
应锟斤拷锟斤拷为锟斤拷锟斤拷统一锟侥凤拷式锟斤拷锟斤拷锟侥碉拷

[minux]

2012/6/17 邱焜 <qyk...@gmail.com>

这是Go的文档风格，所有导出的变量/函数/结构体/接口，以及他们的每一个

导出成员都要有文档说明。

保持这个文档上的一致性比这个文档是不是很显然这点重要得多。

实际上Go标准库的文档要求比这个更严格，连非导出的东西也都会有文档。

[Oling Cat]

译者表示鸭梨山大= =||

--

Hello! This is Oling Cat!

2012/6/19 minux <minu...@gmail.com>

--

[cai xiang]

习惯Javadoc的注释结构.