# Packages
Package messagetest 提供测试生成 message 相关的测试工具.
# Functions
FileURI 根据本地文件路径构建 URI 实例
如果已经存在协议,则不作任何改变返回。.
FullVersion 完整的版本号
会包含版本号、构建日期和最后的提交 ID,大致格式如下: version+buildDate.commitHash.
NewError 返回 *Error 实例.
NewHTTPError 声明 HTTPError 实例.
NewMessageHandler 声明新的 MessageHandler 实例.
Version 程序的版本号
遵守 https://semver.org/lang/zh-CN/ 规则。 程序不兼容或是文档格式不兼容时,需要提升主版本号。.
WithError 采用 err 实例 *Error 实例.
# Constants
消息的分类.
语法错误类型可用的枚举值.
语法错误类型可用的枚举值.
消息的分类.
Name 程序的正式名称.
OfficialURL 官网.
RepoURL 源码仓库地址.
目前 URI 支持的协议.
目前 URI 支持的协议.
目前 URI 支持的协议.
消息的分类.
消息的分类.
XMLNamespace 定义 xml 命名空间的 URI.
# Structs
Block 最基本的代码单位
一般从注释提取的一个完整注释作为 Block 实例。.
Error 用于描述 apidoc 中的大部分错误信息
无论是配置文件的错误,还是文档的语法错误,都将返回此错误。.
HTTPError 表示 HTTP 状态码的错误.
Location 用于描述一段内容的定位
兼容 LSP https://microsoft.github.io/language-server-protocol/specifications/specification-current/#location.
Message 输出消息的具体结构.
MessageHandler 异步的消息处理机制
包含了本地化的信息,输出时,会以指定的本地化内容输出.
Position 用于描述字符在文件中的定位
兼容 LSP https://microsoft.github.io/language-server-protocol/specifications/specification-current/#position.
Range 用于描述文档中的一段范围
兼容 LSP https://microsoft.github.io/language-server-protocol/specifications/specification-current/#range.
RelatedInformation 错误信息的关联内容
兼容 LSP 中的 DiagnosticRelatedInformation 的相关定义
https://microsoft.github.io/language-server-protocol/specifications/specification-3-16/#diagnostic.
# Interfaces
Searcher 实现了搜索的基本方法集合
所有内嵌 Location 的对象都可以使用此接口判断是否内嵌 Location。.
# Type aliases
ErrorType 语法错误的类型.
HandlerFunc 错误处理函数.
MessageType 表示消息的类型.
URI 定义 URI
http://tools.ietf.org/html/rfc3986
foo://example.com:8042/over/there?name=ferret#nose \_/ \______________/\_________/ \_________/ \__/ | | | | | scheme authority path query fragment | _____________________|__ / \ / \ urn:example:animal:ferret:nose
如果是本地相对路径,也可以直接使用 `./path/file` 的形式表示, 不需要指定协议。
NOTE: 并非完整的 URI 实现,仅作为了 file:// 和 http:// 支持, 也提供对 windows 路径的支持。.