erl_comment_scan

模块

erl_comment_scan

模块摘要

用于从Erlang源代码读取注释行的函数。

描述

从Erlang源代码读取注释行的函数。

数据类型

comment()= {Line::integer()，Column::integer()，Indentation::integer()，Text::string()}

出口

file(FileName::file:filename()) -> [Comment]

类型

从Erlang源代码文件中提取注释。返回代表多行注释的条目列表，按照递增的行号顺序列出。对于每个条目，Text是以从上至下的顺序表示连续注释行的字符串列表; 这些字符串包含跟在（但不包括）行上的第一个注释引入字符之后的所有字符%，直到（但不包括）行终止换行符。

此外，注释Line的行号和Column左列（即注释介绍%字符的列）。Indent是缩进（或填充），用评论前面的最后一个非空白字符（或左边距）和评论的左列之间的字符位置度量。Line并且Column总是正整数，并且Indentation是一个非负整数。

{read, Reason}如果发生读取错误，评估将随原因退出，其中Reason是对应于Posix错误代码的原子；file(3)详情请参阅模块。

join_lines(Lines::[CommentLine]) -> [Comment]

类型

将各条评论线加入多行评论。输入是表示单独注释行的条目列表，按行数减少的顺序排列 ; scan_lines/1详情请参阅。结果是表示多行注释的条目列表，仍然按照递减的行号顺序列出，但是对于每个条目，Text是按照递增的行号（即，自上而下）的顺序的连续注释行的列表，。

另见： scan_lines/1。

scan_lines(Text::string()) -> [CommentLine]

类型

从源代码字符串中提取单独的注释行。返回文本中找到的注释行列表，按行数减少的顺序列出，即输入中的最后注释行在结果列表中第一个。Text是一个单个字符串，包含%该行上第一个注释引入字符后面（但不包括）的所有字符，直到（但不包括）行终止换行符。有关详细信息Line，Column并Indent见file/1。

string(Text::string()) -> [Comment]

类型

从包含Erlang源代码的字符串中提取注释。除了直接从字符串中读取外，其行为与for相同file/1。

另见： file/1。

richard@gmail.com