檢視原始碼 tags (tools v4.1.1)

從 Erlang 原始碼檔案產生 Emacs TAGS 檔案

Emacs 使用 TAGS 檔案來尋找大型專案中任何原始碼檔案中的函式和變數定義。此模組可以從 Erlang 原始碼檔案產生 TAGS 檔案。它會識別函式、記錄和巨集定義。

選項

此模組中的函式有一個可選的參數 Options。它是一個列表,可以包含以下元素:

  • {outfile, NameOfTAGSFile} 建立一個名為 NameOfTAGSFileTAGS 檔案。
  • {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 Manual, chapter "Editing Programs", section "Tag Tables". Free Software Foundation, 1995.
  • Anders Lindgren. The Erlang editing mode for Emacs. Ericsson, 1998.

摘要

函式

等同於 dir(Dir, [])

為目錄 Dir 中的所有檔案建立 TAGS 檔案。

DirList 中任何目錄中的所有檔案建立 TAGS 檔案。

等同於 file(Name, [])

為檔案 File 建立 TAGS 檔案。

為列表 FileList 中的檔案建立 TAGS 檔案。

等同於 root([])

建立涵蓋 Erlang 發行版本中所有檔案的 TAGS 檔案。

遞迴地深入目錄 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, [])

連結到此函式

dirs(DirList, Options)

檢視原始碼
-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, [])

連結到此函式

files(FileList, Options)

檢視原始碼
-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()].

建立涵蓋 Erlang 發行版本中所有檔案的 TAGS 檔案。

-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, [])

連結到此函式

subdirs(DirList, Options)

檢視原始碼
-spec subdirs(DirList, Options) -> ok | error when DirList :: [file:filename()], Options :: [option()].

遞迴地深入 DirList 中的目錄,並根據找到的所有檔案建立 TAGS 檔案。