7 内联标签
内联标签通常用于块标签中,例如,用于突出显示段落中的一个词。
7.1 <br> - 换行符
强制换行。<br> 标签既是块标签又是内联标签,在 块标签 部分中进行了描述。
7.2 <c> - 代码
在文本流中突出显示变量和文件名等内容。只能包含纯文本。与 code 标签相反,换行符和制表符将被忽略。所有 字符实体 都将被扩展。示例
<p>Returns <c>true</c> if <c>Term</c> is an integer.</p>
结果为
如果 Term 是一个整数,则返回 true。
7.3 <em> - 强调
突出显示文本流中重要的词。示例
<p>The application <em>must</em> be up and running.</p>
结果为
应用程序 **必须** 处于运行状态。
包含纯文本或 <c> 标签。
7.4 <marker> - 标记
用作超文本引用的锚点。<code>id</code> 属性定义了标记的名称。示例
<marker id="marker_example"/>
<see*> 标签用于引用标记。
<marker> 标签既是块标签又是内联标签。
7.5 <see*> - 参见标签
对同一文件中的标记、另一个文件中的标记或另一个文件(的顶部)的交叉引用(超文本链接),由 <code>marker</code> 属性给出。<code>marker</code> 属性中使用的语法为 <code>application:file#anchor</code>,用于一般情况。如果链接目标是当前应用程序或文件,则可以省略 <code>application</code> 和 <code>file</code>。
有几种不同的参见标签,应根据它们指向的内容使用。
- <seemfa>
-
使用语法 <code>application:module#function/arity</code> 指向 MFA。这些链接必须指向 <funcs> 部分中记录的函数。示例
结果为:string:length/1。<seemfa marker="stdlib:string#length/1">string:length/1</seemfa> <seemfa marker="string#length/1">string:length/1</seemfa> <seemfa marker="#length/1">string:length/1</seemfa>
- <seeerl>
-
指向 Erlang 模块或模块内的自定义 标记。示例
结果为:string(3),string 中的旧 API。<seeerl marker="stdlib:string">string(3)</seeerl>, <seeerl marker="stdlib:string#oldapi">Old API in string</seeerl>
- <seetype>
-
使用语法 <code>application:module#type</code> 指向类型。这些链接必须指向 <datatypes> 部分中记录的类型。示例
结果为:string::grapheme_cluster()。<seetype marker="stdlib:string#grapheme_cluster">string::grapheme_cluster()</seetype>
- <seeapp>
-
指向应用程序文档。<code>index</code> 可用作目标文件。示例
结果为:STDLIB,STDLIB。<seeapp marker="stdlib:STDLIB_app">STDLIB app</seeapp>, <seeapp marker="stdlib:index">STDLIB index</seeapp>
- <seecom>
-
指向任何命令行工具的文档。示例
结果为:epmd。<seecom marker="erts:epmd">epmd</seecom>
- <seecref>
-
指向任何 C 参考资料的文档。示例
结果为:erl_nif。<seecref marker="erts:erl_nif">erl_nif</seecref>
- <seefile>
-
指向文件格式的文档。示例
结果为:config(3)。<seefile marker="kernel:config">config(3)</seefile>
- <seeguide>
-
指向任何应用程序的用户指南。<code>index</code> 可用作目标文件。示例
结果为:Kernel 用户指南索引,Kernel 用户指南中的日志记录。<seeguide marker="kernel:index">Kernel User's Guide Index</seeguide>, <seeguide marker="kernel:logger_chapter">Logging in the Kernel User's Guide</seeguide>
7.6 <url> - 非本地交叉引用
对文档之外的文件、网页地址或类似内容的引用,由 <code>href</code> 属性给出。必须包含纯文本。示例
<url href="https://erlang.ac.cn">erlang.org</url>
结果为:erlang.org