From 2e19c9b6f0791bfb5ee3db3aac3df0f1f553d7fd Mon Sep 17 00:00:00 2001 From: caixw Date: Fri, 1 Mar 2024 23:44:25 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ansi/csi.go | 16 ++++++++-------- ansi/writer.go | 30 +++++++++++++++--------------- colors/colorize.go | 2 +- colors/colors.go | 19 +++++++++---------- 4 files changed, 33 insertions(+), 34 deletions(-) diff --git a/ansi/csi.go b/ansi/csi.go index 73f068f..8c72042 100644 --- a/ansi/csi.go +++ b/ansi/csi.go @@ -68,10 +68,10 @@ func RCP() ESC { return CSI('u') } // ED 返回清除屏幕的控制符 // -// n == 0 时，清除从当前光标到屏幕尾的所有字符； -// n == 1 时，清除从当前光标到屏幕头的所有字符； -// n == 2 时，清除当前屏幕的所有字符； -// 当 n 为其它值时，将触发 panic +// - n == 0 时，清除从当前光标到屏幕尾的所有字符； +// - n == 1 时，清除从当前光标到屏幕头的所有字符； +// - n == 2 时，清除当前屏幕的所有字符； +// - 当 n 为其它值时，将触发 panic func ED(n int) ESC { if n < 0 || n > 2 { panic(fmt.Sprintf("参数 n [%v]必须介于 [0,2]", n)) @@ -81,10 +81,10 @@ func ED(n int) ESC { // EL 获取清除行的控制符 // -// n == 0 时，清除从当前光标到行尾的所有字符； -// n == 1 时，清除从当前光标到行头的所有字符； -// n == 2 时，清除当前行的所有字符。 -// 当 n 为其它值时，将触发 panic +// - n == 0 时，清除从当前光标到行尾的所有字符； +// - n == 1 时，清除从当前光标到行头的所有字符； +// - n == 2 时，清除当前行的所有字符。 +// - 当 n 为其它值时，将触发 panic func EL(n int) ESC { if n < 0 || n > 2 { panic(fmt.Sprintf("参数 n [%v]必须介于 [0,2]", n)) diff --git a/ansi/writer.go b/ansi/writer.go index a41e269..946fd8c 100644 --- a/ansi/writer.go +++ b/ansi/writer.go @@ -10,7 +10,7 @@ import ( "github.com/issue9/errwrap" ) -// Writer ansi 控制码的 io.Writer 接口 +// Writer ansi 控制码的 [io.Writer] 实现 // // a := NewWriter(os.Stdout) // @@ -24,7 +24,7 @@ type Writer struct { w errwrap.Writer } -// NewWriter 声明一个 Writer 结构体 +// NewWriter 声明一个 [Writer] 结构体 func NewWriter(w io.Writer) *Writer { if ww, ok := w.(*Writer); ok { return ww @@ -35,9 +35,9 @@ func NewWriter(w io.Writer) *Writer { // WriteESC 输出字符串 func (w *Writer) WriteESC(esc ESC) *Writer { return w.WBytes([]byte(esc)) } -// Writer 暴露原始的 io.Writer 接口 +// Writer 暴露原始的 [io.Writer] 接口 // -// 此接口的出错误信息会直接返回，并不会记录在 Writer.Err 之中。 +// 此接口的出错误信息会直接返回，并不会记录在 [Writer.Err] 之中。 func (w *Writer) Write(bs []byte) (int, error) { return w.w.Write(bs) } // Left 左移 n 个字符光标 @@ -54,18 +54,18 @@ func (w *Writer) Down(n int) *Writer { return w.WriteESC(CUD(n)) } // Erase 清除屏幕 // -// n==0 时，清除从当前光标到屏幕尾的所有字符； -// n==1 时，清除从当前光标到屏幕头的所有字符； -// n==2 时，清除当前屏幕的所有字符； -// 当 n 为其它值时，将触发 panic +// - n==0 时，清除从当前光标到屏幕尾的所有字符； +// - n==1 时，清除从当前光标到屏幕头的所有字符； +// - n==2 时，清除当前屏幕的所有字符； +// - 当 n 为其它值时，将触发 panic func (w *Writer) Erase(n int) *Writer { return w.WriteESC(ED(n)) } // EraseLine 清除行 // -// n==0 时，清除从当前光标到行尾的所有字符； -// n==1 时，清除从当前光标到行头的所有字符； -// n==2 时，清除当前行的所有字符； -// 当 n 为其它值时，将触发 panic +// - n==0 时，清除从当前光标到行尾的所有字符； +// - n==1 时，清除从当前光标到行头的所有字符； +// - n==2 时，清除当前行的所有字符； +// - 当 n 为其它值时，将触发 panic func (w *Writer) EraseLine(n int) *Writer { return w.WriteESC(EL(n)) } // Move 移动光标到 x,y 的位置 @@ -115,19 +115,19 @@ func (w *Writer) Color256(f, b uint8) *Writer { return w.WriteESC(B256Color(b)) } -// Printf 相当于 fmt.Printf +// Printf 相当于 [fmt.Printf] func (w *Writer) Printf(format string, args ...any) *Writer { w.w.Printf(format, args...) return w } -// Print 相当于 fmt.Print +// Print 相当于 [fmt.Print] func (w *Writer) Print(args ...any) *Writer { w.w.Print(args...) return w } -// Println 相当于 fmt.Println +// Println 相当于 [fmt.Println] func (w *Writer) Println(args ...any) *Writer { w.w.Println(args...) return w diff --git a/colors/colorize.go b/colors/colorize.go index f6c42ad..46ae1c4 100644 --- a/colors/colorize.go +++ b/colors/colorize.go @@ -21,7 +21,7 @@ func New(w io.Writer) *Colorize { return &Colorize{w: ansi.NewWriter(w)} } -// Writer 暴露原始的 io.Writer 接口 +// Writer 暴露原始的 [io.Writer] 接口 // // 此接口的出错误信息会直接返回，并不会记录在 [Colorize.Err] 之中。 func (c *Colorize) Write(bs []byte) (int, error) { return c.w.Write(bs) } diff --git a/colors/colors.go b/colors/colors.go index 38536ba..9105406 100644 --- a/colors/colors.go +++ b/colors/colors.go @@ -26,15 +26,14 @@ import ( // Color 定义了控制台能接受的所有颜色值 // // 颜色定义分为以下几种： -// - 默认色： math.MaxInt32 定义为 Default -// - 基本色： 0-7 定义从 Black 至 White -// - 增强色： 8-15 定义从 BrightBlack 至 BrightWhite -// - 256 色： 0-256，数值，其中 0-15 的数据会被转换成以上的色彩； -// - 真彩色： 负数，可由 [RGB] 函数生成； +// - 默认色： math.MaxInt32 定义为 Default +// - 基本色： 0-7 定义从 Black 至 White +// - 增强色： 8-15 定义从 BrightBlack 至 BrightWhite +// - 256 色： 0-256，数值，其中 0-15 的数据会被转换成以上的色彩； +// - 真彩色： 负数，可由 [RGB] 函数生成； // // 默认色、增强色和 256 色基本上所有的终端都支持， -// 而 24 位真彩色则未必所有终端都支持， -// 比如 macOS 自带的终端对该色彩支持并不好。 +// 而 24 位真彩色则未必所有终端都支持，比如 macOS 自带的终端对该色彩支持并不好。 // // 关于颜色的具体定义，可参考以下文章 [ANSI_escape_code] // @@ -141,9 +140,9 @@ func RGB(r, g, b uint8) Color { // HEX 以 16 进制的形式转换成颜色 // // 可以由以下形式： -// - HEX("#aaa") ==> RGB(0xaa, 0xaa, 0xaa) -// - HEX("aaa") ==> RGB(0xaa, 0xaa, 0xaa) -// - HEX("ababab") ==> RGB(0xab, 0xab, 0xab) +// - HEX("#aaa") ==> RGB(0xaa, 0xaa, 0xaa) +// - HEX("aaa") ==> RGB(0xaa, 0xaa, 0xaa) +// - HEX("ababab") ==> RGB(0xab, 0xab, 0xab) func HEX(hex string) Color { if len(hex) == 0 { panic("无效的参数 hex")