comments

README

サンプルリスト

このディレクトリには以下のサンプルがあります。

file	example name	note
comments_basic.go	comment_basic_usage	GO言語のコメントスタイルについてのサンプルです.

Documentation

Overview

Package comments -- GO言語のコメントスタイルについてのサンプルがあるパッケージです

GO言語のコメントスタイルについては以下を参照.

• http://bit.ly/2HS4sg4

スラッシュとアスタリスクを利用するコメントは「パッケージ用」

ダブルスラッシュを利用するコメントは「通常用、または、関数説明など」

- 全てのパッケージは、パッケージコメントを持つべきである。

(Every package should have a package comments)

- 関数などのドキュメントコメント(doc comments) は、そのアイテムの名前から始める。

(every doc comments begins with the name of the item it describes)

Package comments -- Go言語のコメントについてのサンプルが配置されているパッケージです。

Index

• func Basic() error
• func NewRegister() mapping.Register

Functions

func Basic

func Basic() error

Basic は、GO言語のコメントスタイルについてのサンプルです.

func NewRegister

func NewRegister() mapping.Register

NewRegister -- このパッケージ用のサンプルを登録する mapping.Register を生成します。