查看源代码 tags (工具 v4.1.1)
从 Erlang 源代码文件生成 Emacs TAGS 文件
TAGS
文件被 Emacs 用于在大型项目的任何源代码文件中查找函数和变量定义。此模块可以从 Erlang 源代码文件生成 TAGS
文件。它识别函数、记录和宏定义。
选项
此模块中的函数有一个可选参数 Options
。它是一个列表,可以包含以下元素:
{outfile, NameOfTAGSFile}
创建一个名为NameOfTAGSFile
的TAGS
文件。{outdir, NameOfDirectory}
在目录NameOfDirectory
中创建一个名为TAGS
的文件。
默认行为是在当前目录中创建一个名为 TAGS
的文件。
示例
tags:root([{outfile, "root.TAGS"}]).
此命令将在当前目录中创建一个名为
root.TAGS
的文件。该文件将包含对 Erlang 发行版中所有 Erlang 源代码文件的引用。tags:files(["foo.erl", "bar.erl", "baz.erl"], [{outdir, "../projectdir"}]).
此命令将创建一个名为
TAGS
的文件,并将其放置在目录../projectdir
中。该文件包含有关这三个文件的函数、记录和宏定义的信息。
另请参阅
- Richard M. Stallman. GNU Emacs 手册,章节 "编辑程序",部分 "标签表"。自由软件基金会,1995 年。
- Anders Lindgren. 用于 Emacs 的 Erlang 编辑模式。爱立信,1998 年。
概要
函数
等同于 dir(Dir, [])
。
为目录 Dir
中的所有文件创建一个 TAGS
文件。
为 DirList
中任何目录中的所有文件创建一个 TAGS
文件。
等同于 file(Name, [])
。
为文件 File
创建一个 TAGS
文件。
为列表 FileList
中的文件创建一个 TAGS
文件。
创建一个 TAGS
文件,涵盖 Erlang 发行版中的所有文件。
递归地进入目录 Dir
,并基于找到的所有文件创建一个 TAGS
文件。
递归地进入 DirList
中的目录,并基于找到的所有文件创建一个 TAGS
文件。
类型
-type option() :: {outfile, NameOfTAGSFile :: file:filename()} | {outdir, NameOfDirectory :: file:filename()}.
函数
-spec dir(Dir) -> ok | error when Dir :: file:filename().
等同于 dir(Dir, [])
。
-spec dir(Dir, Options) -> ok | error when Dir :: file:filename(), Options :: [option()].
为目录 Dir
中的所有文件创建一个 TAGS
文件。
-spec dirs(DirList) -> ok | error when DirList :: [file:filename()].
等同于 dirs(Dirs, [])
。
-spec dirs(DirList, Options) -> ok | error when DirList :: [file:filename()], Options :: [option()].
为 DirList
中任何目录中的所有文件创建一个 TAGS
文件。
-spec file(File) -> ok | error when File :: file:filename().
等同于 file(Name, [])
。
-spec file(File, Options) -> ok | error when File :: file:filename(), Options :: [option()].
为文件 File
创建一个 TAGS
文件。
-spec files(FileList) -> ok | error when FileList :: [file:filename()].
等同于 files(Files, [])
。
-spec files(FileList, Options) -> ok | error when FileList :: [file:filename()], Options :: [option()].
为列表 FileList
中的文件创建一个 TAGS
文件。
-spec root() -> ok | error.
等同于 root([])
。
-spec root(Options) -> ok | error when Options :: [option()].
创建一个 TAGS
文件,涵盖 Erlang 发行版中的所有文件。
-spec subdir(Dir) -> ok | error when Dir :: file:filename().
等同于 subdir(Dir, [])
。
-spec subdir(Dir, Options) -> ok | error when Dir :: file:filename(), Options :: [option()].
递归地进入目录 Dir
,并基于找到的所有文件创建一个 TAGS
文件。
-spec subdirs(DirList) -> ok | error when DirList :: [file:filename()].
等同于 subdirs(Dirs, [])
。
-spec subdirs(DirList, Options) -> ok | error when DirList :: [file:filename()], Options :: [option()].
递归地进入 DirList
中的目录,并基于找到的所有文件创建一个 TAGS
文件。