code review 5876057: crypto/md5: add example codes to package documentation

crypto/md5: add example codes to package documentation

[liigo, 2012-03-22 17:06:51]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://code.google.com/p/go

[remyoudompheng, 2012-03-22 20:05:08]

There's already an example in crypto/md5. Why add another one (and not in
Example format)?

[bradfitz, 2012-03-22 21:05:18]

Sorry, but we already have an Example on New.

Maybe this is http://code.google.com/p/go/issues/detail?id=3242


On Thu, Mar 22, 2012 at 10:06 AM, <com.liigo@gmail.com> wrote:

> Reviewers: golang-dev_googlegroups.com,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://code.google.com/p/go
>
>
> Description:
> crypto/md5: add example codes to package documentation
>
> Please review this at
http://codereview.appspot.com/**5876057/<http://codereview.appspot.com/5876057/>
>
> Affected files:
>  M src/pkg/crypto/md5/md5.go
>
>
> Index: src/pkg/crypto/md5/md5.go
> ==============================**==============================**=======
> --- a/src/pkg/crypto/md5/md5.go
> +++ b/src/pkg/crypto/md5/md5.go
> @@ -2,7 +2,47 @@
>  // Use of this source code is governed by a BSD-style
>  // license that can be found in the LICENSE file.
>
> -// Package md5 implements the MD5 hash algorithm as defined in RFC 1321.
> +/*
> +Package md5 implements the MD5 hash algorithm as defined in RFC 1321.
> +
> +Example
> +
> +Here is a complete, ready to use, example:
> +
> +  package main
> +
> +  import (
> +       "fmt"
> +       "crypto/md5"
> +  )
> +
> +  func main() {
> +       // Uses md5.New() to create a hash.Hash interface object
> +       h := md5.New()
> +
> +       // Write the data to hash.Hash
> +       h.Write([]byte{1,2,3})
> +
> +       // h.Sum(nil) returns data with the type of []byte, such as:
> +       // [82 137 223 115 125 245 115 38 252 221 34 89 122 251 31 172].
> +       // And fmt.Sprintf("%x", h.Sum(nil)) returns regular MD5 string,
> such as:
> +       // "**5289df737df57326fcdd22597afb1f**ac".
> +       md5String := fmt.Sprintf("%x", h.Sum(nil))
> +       fmt.Println(md5String)
> +  }
> +
> +And here is a help function to calculate MD5 string:
> +
> +  func MD5String(data []byte) string {
> +       h := md5.New()
> +       h.Write(data)
> +       return fmt.Sprintf("%x", h.Sum(nil))
> +  }
> +
> +  func main() {
> +       fmt.Println(MD5String([]byte{**1,2,3}))
> +  }
> +*/
>  package md5
>
>  import (
>
>
>

[liigo, 2012-03-23 08:34:56]

Thanks for reply. Example in package documentation should be better, i 
think. It's not only for "how to New", it demos "how to get MD5" or "how to 
use the md5 pkg". Maybe the example in New should move away.


在 2012年3月23日星期五UTC+8上午5时05分17秒，Brad Fitzpatrick写道：
>
> Sorry, but we already have an Example on New.
>
> Maybe this is
http://code.google.com/p/​go/issues/detail?id=3242<http://code.google.com/p/g...
>
>
> On Thu, Mar 22, 2012 at 10:06 AM, <com.liigo@gmail.com> wrote:
>
>> Reviewers: golang-dev_googlegroups.com,
>>
>> Message:
>> Hello golang-dev@googlegroups.com,
>>
>> I'd like you to review this change to
>> https://code.google.com/p/go
>>
>>
>> Description:
>> crypto/md5: add example codes to package documentation
>>
>> Please review this at
http://codereview.appspot.com/**​5876057/<http://codereview.appspot.com/58760...
>>
>> Affected files:
>>  M src/pkg/crypto/md5/md5.go
>>
>>
>> Index: src/pkg/crypto/md5/md5.go
>> ==============================**​==============================**​=======
>> --- a/src/pkg/crypto/md5/md5.go
>> +++ b/src/pkg/crypto/md5/md5.go
>> @@ -2,7 +2,47 @@
>>  // Use of this source code is governed by a BSD-style
>>  // license that can be found in the LICENSE file.
>>
>> -// Package md5 implements the MD5 hash algorithm as defined in RFC 1321.
>> +/*
>> +Package md5 implements the MD5 hash algorithm as defined in RFC 1321.
>> +
>> +Example
>> +
>> +Here is a complete, ready to use, example:
>> +
>> +  package main
>> +
>> +  import (
>> +       "fmt"
>> +       "crypto/md5"
>> +  )
>> +
>> +  func main() {
>> +       // Uses md5.New() to create a hash.Hash interface object
>> +       h := md5.New()
>> +
>> +       // Write the data to hash.Hash
>> +       h.Write([]byte{1,2,3})
>> +
>> +       // h.Sum(nil) returns data with the type of []byte, such as:
>> +       // [82 137 223 115 125 245 115 38 252 221 34 89 122 251 31 172].
>> +       // And fmt.Sprintf("%x", h.Sum(nil)) returns regular MD5 string, 
>> such as:
>> +       // "**5289df737df57326fcdd22597afb1​f**ac".
>> +       md5String := fmt.Sprintf("%x", h.Sum(nil))
>> +       fmt.Println(md5String)
>> +  }
>> +
>> +And here is a help function to calculate MD5 string:
>> +
>> +  func MD5String(data []byte) string {
>> +       h := md5.New()
>> +       h.Write(data)
>> +       return fmt.Sprintf("%x", h.Sum(nil))
>> +  }
>> +
>> +  func main() {
>> +       fmt.Println(MD5String([]byte{**1​,2,3}))
>> +  }
>> +*/
>>  package md5
>>
>>  import (
>>
>>
>>
>

[gobot, 2013-12-18 15:43:45]

R=close (assigned by rsc@golang.org)

[gobot, 2013-12-18 16:20:11]

R=close (assigned by rsc@golang.org)