input

package
v0.0.0-...-643d18f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 14, 2018 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

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

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Parse

func Parse(ctx context.Context, h *errors.Handler, inputs ...*opt.Input) (chan Block, error)

Parse 分析源代码,获取相应的文档内容。

当所有的代码块已经放入 Block 之后,Block 会被关闭。

所有与解析有关的错误均通过 h 输出。而其它错误,比如参数问题等,通过返回参数返回。

Types

type Block

type Block struct {
	File string
	Line int
	Data []byte
}

Block 解析出来的注释块

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL