golangtips

README

逆引きGolang

逆引きRubyの内容をGolang化した(しつつある）ものです。 htmlはこちらで公開しています。

誤りがあったりもっとうまく書ける場合はPull Requestを投げてください。

実行

（内容的に全部を実行して嬉しい人はあまり居ないと思いますが..)

go run main.go

所々、必要なパッケージは go get してください。

フォルダ・ファイル構成

pkg/tips_HOGE/tips_HOGE.gp 以下の関数Tips_HOGE()で、HOGEに関するTipsのコードが 全て実行されます。関数はすべてHOGE_hoge()という命名規則です。

ドキュメント生成

Pandocが必要です。

cd doc
ruby make_doc.rb

markdownフォルダ以下に *.mdが、 htmlフォルダ以下に *.html が生成されます。

関数の頭の表記を下記規則に従って変換します。

//---------------------------------------------------
// Tipsの名前
//---------------------------------------------------
/*
コメント(markdown表記できます)
*/
// import "hogehoge"
func HOGE_hogehoge() {
    
}

func hogehoge(){ //HOGE_hogehoge()から呼ばれる関数
    
}

基本的には各Tipsが全コピペで動作するように、

package main

import "fmt"

などを追加します。fmt以外のimport文の抽出は自動では難しいので コメントアウトして書いてあるもの（上記例では // import "hogehoge")を使います。

License

MIT license

Credits

• RubyTips is founded by TAKEUCHI Hitoshi.

• HTMLs are generated by Pandoc and decorated by github.css.

• Golang codes are highlighted by highlight.js, which is released under the BSD License.

• The Go gopher was designed by Renee French. The gopher vector data was made by Takuya Ueda. Licensed under the Creative Commons 3.0 Attributions license.

• The Gppher favicon was designed by mccoyst