input

Documentation

Overview

Package input 用于处理输入的文件，从代码中提取基本的注释内容。

多行注释和单行注释在处理上会有一定区别：

• 单行注释，风格相同且相邻的注释会被合并成一个注释块；
• 单行注释，风格不相同且相邻的注释会被按注释风格多个注释块；
• 多行注释，即使两个注释释块相邻也会被分成两个注释块来处理。

Index

• func Parse(h *message.Handler, opt ...*Options) (*doc.Doc, error)
• type Options
  • func Detect(dir string, recursive bool) ([]*Options, error)

Functions

func Parse

func Parse(h *message.Handler, opt ...*Options) (*doc.Doc, error)

Parse 分析从 input 中获取的代码块

所有与解析有关的错误均通过 h 输出。 如果是配置文件的错误，则通过 error 返回

Types

type Options

type Options struct {
	// 输入的目标语言
	//
	// 取值为 lang.Language.Name
	Lang string `yaml:"lang"`

	// 源代码目录
	Dir string `yaml:"dir"`

	// 需要扫描的文件扩展名
	//
	// 若未指定，则根据 Lang 选项获取其默认的扩展名作为过滤条件。
	Exts []string `yaml:"exts,omitempty"`

	// 是否查找 Dir 的子目录
	Recursive bool `yaml:"recursive"`

	// 源文件的编码，默认为 UTF-8
	Encoding string `yaml:"encoding,omitempty"`
	// contains filtered or unexported fields
}

Options 指定输入内容的相关信息。

func Detect

func Detect(dir string, recursive bool) ([]*Options, error)

Detect 检测指定目录下的内容，并为其生成一个合适的 input.Options 实例。

检测依据为根据扩展名来做统计，数量最大且被支持的获胜。