Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mozillazg committed Mar 12, 2016
1 parent 15b0045 commit c24290a
Showing 1 changed file with 39 additions and 38 deletions.
77 changes: 39 additions & 38 deletions doc.go
Original file line number Diff line number Diff line change
@@ -1,39 +1,40 @@
// Package pinyin : 汉语拼音转换工具
//
// Usage
//
// package main
//
// import (
// "fmt"
// "github.com/mozillazg/go-pinyin"
// )
//
// func main() {
// hans := "中国人"
// // 默认
// a := pinyin.NewArgs()
// fmt.Println(pinyin.Pinyin(hans, a))
// // [[zhong] [guo] [ren]]
//
// // 包含声调
// a.Style = pinyin.Tone
// fmt.Println(pinyin.Pinyin(hans, a))
// // [[zhōng] [guó] [rén]]
//
// // 声调用数字表示
// a.Style = pinyin.Tone2
// fmt.Println(pinyin.Pinyin(hans, a))
// // [[zho1ng] [guo2] [re2n]]
//
// // 开启多音字模式
// a = pinyin.NewArgs()
// a.Heteronym = true
// fmt.Println(pinyin.Pinyin(hans, a))
// // [[zhong zhong] [guo] [ren]]
// a.Style = pinyin.Tone2
// fmt.Println(pinyin.Pinyin(hans, a))
// // [[zho1ng zho4ng] [guo2] [re2n]]
// }
//
/*
Package pinyin : 汉语拼音转换工具.
Usage
package main
import (
"fmt"
"github.com/mozillazg/go-pinyin"
)
func main() {
hans := "中国人"
// 默认
a := pinyin.NewArgs()
fmt.Println(pinyin.Pinyin(hans, a))
// [[zhong] [guo] [ren]]
// 包含声调
a.Style = pinyin.Tone
fmt.Println(pinyin.Pinyin(hans, a))
// [[zhōng] [guó] [rén]]
// 声调用数字表示
a.Style = pinyin.Tone2
fmt.Println(pinyin.Pinyin(hans, a))
// [[zho1ng] [guo2] [re2n]]
// 开启多音字模式
a = pinyin.NewArgs()
a.Heteronym = true
fmt.Println(pinyin.Pinyin(hans, a))
// [[zhong zhong] [guo] [ren]]
a.Style = pinyin.Tone2
fmt.Println(pinyin.Pinyin(hans, a))
// [[zho1ng zho4ng] [guo2] [re2n]]
}
*/
package pinyin

0 comments on commit c24290a

Please sign in to comment.