在synph中用于编程语言的类型名称的DITA元素是什么?

时间:2015-08-05 16:09:14

标签: dita

给出一些编程语言文本,例如

int foo (int a);

function foo (a : int) return int;

以及在语法指导下将标记放在结构上重要的部分的目标。作为int的一部分,将<synph>类型的名称放入哪个元素的正确选择是什么?请注意,此标记不是用于显示代码块,而是用于描述syntactic structure。我到目前为止

int <var>foo</foo>
<delim>(</delim>
  int <parmname>a</parmname>
<delim>)</delim><delim>;</delim>

即使<var>在函数名称周围似乎也不正确,因为var表示可替换,但并非所有函数都可以。只需<text>

我意识到这个例子使用了个人的名字,而铁路图,语法等则会有更抽象的名字。所以,也许更常见的例子是

function FUNCTION-NAME (VAR-NAME : TYPE-NAME) return TYPE-NAME;

因此,变化的问题变成:我对TYPE-NAME使用什么标记? DITA专业化是否实用?

1 个答案:

答案 0 :(得分:0)

代码块的正确元素是codeblock。你不应该标记每一个字符串。这仅适用于内联元素。您可能想要查看programming domain的所有相关元素。如果您发布数据,则应使用突出显示器自动突出显示块的语法。您可以使用@outputclass告诉荧光笔它必须使用哪种语言。