1.3. 写作约定
命令行提示符
在本书的教授过程中,我将使用 $
符号来作为命令行提示符,如:
$ echo "Hello Go!"
Hello Go!
带有 $
符号的第一行代码指的是我们在命令行端口中输入的命令 echo "Hello Go!"
。echo
是 Unix 系统中常用的输出命令,用于输出指定字符串。第二行的 Hello Go!
是运行命令后的输出信息。后面我们会使用这种风格来表示命令行的输入与输出,因此你在复制命令行的时候要注意不要把 $
和输出信息也复制进去了。
相对文件路径
针对每个人不同的工作环境,本书将统一默认为项目的根目录,而不是项目在文件系统中的完整路径。
例如在我电脑中 main.go
文件的完整路径为:
/Users/summer/Code/go/src/github.com/summerblue/gohub/main.go
但在本书中,文件名路径参照的是项目的根目录,显示如下:
main.go
这样就能保证每个人看到的路径名称都一致了。
竖排 ‘…’ 代码省略
最后,为了保持文章的篇幅简洁,我会将一些不必要的代码使用竖排的 .
来代替,你在复制本文代码块的时候,切记不要将 .
也一同复制进去。演示代码如下:
package main
import (
"fmt"
"net/http"
)
.
.
.
func main() {
http.HandleFunc("/", handlerFunc)
http.ListenAndServe(":3000", nil)
}
排版规范
此文档遵循 中文排版指南 规范,并在此之上遵守以下约定: