输出文档注解关联-vendorchain.PDFVIP

文档生成 Sigasi Studio文档生成器通过自动从HDL源文件中提取信息，使文档处理更容易 。最大的优点是你的设计和文档只有一个来源。虽然这并不能保证与文档保持 同步的设计，但这肯定会使它更容易。 SIGASI文档生成器具有以下优点： •没有特殊的编码要求：代码中的普通注释是为文档提取的，不需要特殊的注释 。SIGASI使用与悬停提供程序相同的代码/注释关联。因此，为了记录一个端口 ，您可以向端口声明添加注释。要记录一个体系结构，你必须把评论放在体系 结构的顶部。 •全部包括在内。所有的文档处理都是在SIGASI/Eclipse 中完成的。所以你不需 要安装额外的工具。 •完全超链接PDF 。如果导出文档，则得到完全超链接的PDF 。 •实时预览：在键入代码和注释时，您可以看到文档的外观。 输出文档 您可以通过单击保存图标或通过Export...菜单将整个项目或特定顶层的文档导出 到pdf 。 结果保存在项目的根目录中的SIGASI DOC文件夹中。 由于Sigasi Studio 2.27，此导出还保存了DoBook源代码，如果您有SIGASI Studio XPRT许可证。这使您能够自定义PDF生成流。没有SIGASI Studio XPRT许 可证的用户也可以导出PDF，但它将包含水印。 所有错误都记录到控制台视图。 自定义模板 用于文档的模板可以在工作区中被复制和修改，这样模板定制就不会被Sigasi Studio的更新覆盖。  在工作空间下建一个新的文件夹: workspace/.metadata/sigasi- templates  拷贝需要的模板从 intstalldir/plugins/com.sigasi.hdt.docgen.resources_version/templates to the workspace/.metadata/sigasi-templates folder.  编辑 workspace/.metadata/sigasi-templates/template.xml file. 注解关联 HDL代码中的注释用于向代码中添加额外的信息或文档。Sigasi Studio使用某些 规则来确定哪个评论属于哪个代码。这对于文档抓取、重构、格式化、……非常 重要。哪种注释属于确切的代码是主观的。 Sigasi Studio用以下规则与HDL声明进行关联: 如果在注释之前并且在同一行（尾随注释）中有声明，则注释与此声明相关联 。此注释可以跨多个单行注释，如果它们对齐的话。 ·如果没有尾随注释，并且在声明上面的行上有具有相同缩进的注释，则该注 释与该声明相关联。如果所有注释具有相同的缩进，则此注释可以跨越多行。 空行中断注释块 关联规则在下面的图像中示出: 根据关联规则，格式化程序和结构选择尊重（和固定）注释。 特别的案例 VHDL组件和组件实例化：如果一个组件（或其一个端口或泛型）本身没有注释 ，Sigasi Studio将使用相应实体的注释。这也适用于组件实例化。 基于标记的注释标记 VHDL和System Verilog注释是用一个标记处理器处理的。这允许在注释中添加 标记（例如，粗体、代码、段落、超链接、……）。这导致更好的徘徊和文档。 在HOVER 中，支持完整的标记语法。对于PDF文档生成，支持以下功能:  段落（添加和空注释行以打断段落）  行中断（通过添加两个尾随空间）  强调（*强调）  强  列表  表（对齐）  外部链接和电子邮件地址（http://www. ，[sigasi] （ ）和销售@ SIGASI.COM ）