原文链接     译者:carvendy

片段宏指南

当你使用Maven生成你的web项目，你有一部分动态选项是包括一些源码片段在你的源码页中。

一个片段是一个源码文件的部分，有指定格式的注释。

这个功能受到汇集的片段宏启发，被Maven的Doxia项目提供一种通过 Maven Site Plugin的方式。

在你的文档中包含源码片段，首先在源文档中想要包含的行加入注释，然后参考文档文件片段的id。每个片段必须分配一个id,和id在源文档中必须唯一。如果你想包含实体文件，那么id参数不需要。

在各种源文件里面这些例子，正如在APT文档格式相应的宏。

想得到更多信息和例子请看Doxia宏指南。

源码片段

Java

// START SNIPPET: snip-id
    public static void main( String[] args )    {
        System.out.println( "Hello World!" );
    }    // END SNIPPET: snip-id

XML

<!-- START SNIPPET: snip-id -->
  <navigation-rule>
    <from-view-id>/logon.jsp</from-view-id>
    <navigation-case>
      <from-outcome>success</from-outcome>
      <to-view-id>/mainMenu.jsp</to-view-id>
    </navigation-case>
  </navigation-rule>
  <!-- END SNIPPET: snip-id -->

JSP

<%-- START SNIPPET: snip-id --%>
  <ul>
      <li><a href="newPerson!input.action">Create</a> a new person</li>
      <li><a href="listPeople.action">List</a> all people</li>
  </ul>
  <%-- END SNIPPET: snip-id --%>