Documentation ANTLR如何执行角色操纵?

ANTLR 3似乎在其规则中使用了某种类似正则表达式的操作,有人知道它是否使用了自定义语法以及相关文档在哪里吗?来自ANTLR wiki: 另见和 Symbol |说明 ----------------+-------------------------------------------------------- $|属性 @|行动 ::|操作或动态作用域属性作用域说明符 :|规则定义 ; | 结束规则 ||备选方案 's'|字符或字符串文字 .

Documentation 开发文档

我们是一个开发团队,我们需要记录我们的代码。 每个开发人员都处理一部分可以作为模块调用的代码。 我们需要一份包含此规范的文档 它应该易于实现和使用 每个开发人员记录自己的工作,当另一个开发人员需要了解任何模块时,他/她不必向原始开发人员询问文档。他/她应该能够自己找到文件 我们应该能够搜索整个文档 您对此有什么建议吗?大多数语言都有从代码注释生成文档的方法。Java和JavaScript都有将注释转换为API规范的方法,比如Java的Javadocs。这实际上取决于您使用的平台。您讨论的是设计决

Documentation 在Mac上手动安装PHPDocumentor

在尝试使用PEAR安装安装PHPDocumentor后,没有成功,我手动尝试了它,详情见官方网站: 我下载了这些文件,并在/usr/bin/上创建了一个别名,但是当我试图通过终端y执行phpdoc.php时,它显示了一个错误 这就是我所尝试的: > cd /usr/bin/ > ./phpdoc.php 这就是错误: PHP Warning: include_once(/Applications/MAMP/htdocs/phpdocumentor/src/phpDocumento

Documentation 是闪电战++;矩阵可用吗?

是否有Blitz++矩阵的文档可用? 我用谷歌找到的,但这似乎不包含文档 我发现的唯一有用的示例来自: #包括 #包括 int main() { 使用名称空间闪电战; TinyMatrix A、B、C; A=1,2,3,, 4, 5, 6, 7, 8, 9; B=1,0,0, 0, 1, 0, 0, 0, 1; C=产品(A,B); std::cout该网站目前似乎已被破坏。不过,Blitz的完整文档包含在该软件包中,可从SourceForge上下载 在Blitz中没有像BigMatrix这样的

Documentation 如何在doxygen中支持注释的多种输出语言

我有一些评论,是用多种语言写的,以下是评论: /** * \brief Norwegian * * Norwegian Bokmål. * */ 我使用doxygen生成文档。在doxygen配置文件中,输出语言的值为英语 在生成的文档中,“Bokmål”未显示,即: Norwegian Bokm�l. 有人知道正确显示“Bokmål”的方法吗 提前谢谢 这可能是在配置文件中设置正确的输入编码的问题,即 INPUT_ENCODING = ISO-8859-1 默认编码是UTF-8

Documentation KDoc:插入代码段

如何在Kotlin的默认文档工具KDoc中插入代码段 在Java中,我可以使用以下内容: /** * Example usage: * * <pre> * <code>&#64;JavaAnnotation * public void foo() { * // Code * } * </code> * </pre> */ @Retention(RetentionPolicy.RUNTIME) @Target(El

Documentation 记录文件命名约定

我正在写一些关于配置文件的文件命名的文档,我不知道这个问题是否属于这里,因为它与代码无关,但在这里 因此,我想描述如何命名文件,我有一些大致如下的内容: {client_name}-{product_name}-{seasure}-{id}.yaml 现在我的问题是,因为客户名称、产品名称、季节和id不一定是变量名称,只是用来描述字符串的位置,在多个单词描述中应该有下划线,还是应该用空格分隔,比如: {client name}-{product name}-{seasure}-{id}.yaml

Documentation 软件文档模板

有人知道软件需求、构建环境描述和其他软件开发常见文档的示例和模板的来源吗 谢谢 来自底格里斯的标准非常全面,尽管您需要了解html或有一个好的html编辑器来使用它们。IEEE提供了软件文档的标准。例如,IEEE 830-1993软件需求规范中定义了高级需求 这是我在学校学到的一个标准(使用Eric J.Braude的《软件工程——面向对象的视角》一书,但我并不特别推荐),它更适合传统的瀑布式开发模型 用谷歌搜索标准号码会得到几个有趣的链接 (IEEE 830-1993标准被IEEE 830-1

Documentation 如何使用Sandcastle帮助文件生成器生成没有文档源的文档?

我希望能够使用Sandcastle从现有主题文件(.AML)生成帮助文档。我使用Sandcastle帮助文件生成器来帮助配置和生成文档 我不想发布任何代码文档,但是,如果我没有指定文档源(例如,项目、解决方案、dll、exe等),则生成失败 如何配置Sandcastle帮助文件生成器,以便在不公开代码文档的情况下生成文档?这是通过启用项目属性中的插件配置来实现的。只需添加此插件即可生成所需的输出

Documentation 如何拥有多个DoxyFile?

我正在从事一个包括其他第三方库的项目。所有这些第三方库都有自己的Doxyfile,并且每个库都有自己特定的“Image”文件夹。不幸的是,其中一些库使用相同的命名约定来命名图像 由于这个原因,如果我为整个源代码树(包括第三方库)生成一个文档,它会由于图像名称冲突而变得模棱两可,并且包含来自错误文件夹的图像 如何使用多个Doxygen文件,使每个库都有自己的沙盒?最后,整个文档输出可以以某种方式相互关联?查看doxygen手册中关于的章节。使用标记文件很容易实现您想要的

Documentation 这份文件有什么遗漏吗?

我已经编写了一个相当简单的类的文档,但我觉得还不够清楚。我应该改变什么吗 /** Pointer class that wraps resources loaded through the ResourceManager. The manager is notified to increase or decrease the reference count of a resource, as a ResourcePtr gets copied, created, or d

Documentation 记录应用程序服务器

是否有人愿意共享服务器文档模板?我曾经在应用服务器(Linux)上工作过一段时间,现在我必须记录所有内容,以便将我的所有工作交付给其他人。试试Sydi。。这将使用脚本为您记录服务器

Documentation 我可以使用Kinect在8';x6和x27;墙

我有一个轻巧的机器人,用磁力挂在金属墙上。我正试图追踪它的位置 如果机器人是6“x6”(x4”深),Kinect测距仪是否有足够的距离和分辨率来跟踪它在8“x6”墙上的任何位置?如果是,我应该预期什么样的错误 我找不到关于硬件的任何像样的文档。如果有人可以链接到某些文档,我可以处理这些数字。是的,但是使用Kinect不会比使用其他相机系统给您带来显著的好处 Kinect的RGB摄像头以1280x960分辨率()存储3个通道。这足以提取您所需的数据,但您可能不需要那么高的分辨率。此外,具有同样高(

Documentation 带图表的文件”;超链接“;在企业架构师中?

我正在努力将所有必需的(并且只有必需的)信息输入到我的企业架构师项目的文档中。准确地说:我们通过使用通用工具箱中的“超链接”元素,对各种需求进行了建模,并在图表中显示了这些需求的源“标准”。(这使我们能够捕获标题、找到文档的网站以及该文档的描述) 现在这个元素在图上是可见的,但在我们模型的包视图中是不可见的,并且它不会在我们的word(docx)文档中生成 我可以在文档中看到这一点,因为基本上打印所有内容的“模型报告”会打印超链接。但是我无法在我的模板中找到我必须选择的内容(在包树状视图中,作为

Documentation 开发人员的技术文档

我有一个用户和权限矩阵图和一个交互图,显示了哪种类型的用户角色可以编辑/添加哪种用户角色(例如,管理员可以为系统中的所有用户授予访问权限,“普通用户”不能为任何用户授予角色/访问权限) 要求是:“为开发人员开发所需的所有软件文档。这是开发人员开始使用功能的输出”。这是在我们有一个web应用程序的情况下给出的,开发人员需要开始处理此用户/权限角色,并了解如何将每种类型的用户的功能绑定在一起 我的问题是,我怎么能做这样的事情?需要什么样的文档、信息,以及在任何地方是否有任何示例?我以前做过业务需求文

Documentation 发行说明,为什么?

发行说明的目的是什么?谁阅读?它们是否应该/可以通过为当前版本发布错误修复来实现自动化,或者它们是否值得仔细的人工编辑? 因此,任何人都可以链接到软件发行说明方面的最佳实践(背后的推理)?这实际上取决于您的应用程序是为谁构建的,以及您的组织目标。然而,我倾向于认为发行说明需要是特定发行版中包含的重要关键添加、增强或修复的简明列表 有时候一个简单的bug跟踪系统信息转储就足够了,其他时候,我发现它们需要改进 关键是发行说明通常被认为是“嘿,看看我们做了什么”类型的更改列表。错误修复和添加的功能。用

Documentation 如何在编码前记录系统流程?

有人能帮我吗 问题是 当我必须编码时,比如说,注册表单,我添加新表单并开始编码。但有时表单有点复杂,我发现自己在重复代码,一遍又一遍地进行相同的验证,使代码变得凌乱 我想知道是否有某种工具允许我在编码之前创建此表单的流程,如流程图。。。在那里,我可以找到这样的地方,我复制代码,然后避免 谢谢 为此设计的真正的工具/语言是。你可以仔细阅读 但是它非常严格。尽管你不必遵循所有的规范和惯例。有几种类型的图表几乎涵盖了所有内容。但实际上只有4台在使用 我认识的大多数人都喜欢画画 谷歌文档绘图是完美的 但

Documentation 文档/重构文本模板功能

如何使用实际值自定义.rst文件中的占位符 例如,我有example.rst文件,其中包含以下内容: Header ------------------------------------ ${custom_text} custom_text=this is the value of custom property 我想用值替换${custom_text}属性这是自定义属性的值,方法是运行以下命令: rst2html example.rst -o example.html -Dcustom

Documentation 在何处查找PyGObject的引用

我正在开发一个基于Python的源代码编辑器。我用Gtk.Notebook创建了一个干净的布局。使用Glade创建主布局很容易,但在我导入gi.repository之后,一切都变得很困难。很难找到文档。从pydoc我什么也得不到,只有方法签名,通常是*args、**kwargs。我经常需要检查一个方法返回或接收什么,而我还没有真正开始信号和其他东西 是否有完整/几乎完整的文档,尤其是GtkSource文档?GtkSource尤其没有文档记录。您可能应该阅读我对类似SO问题的回答:。简言之,你应该

Documentation 为Sandcastle MS帮助查看器输出指定根容器

我正在使用Sandcastle帮助文件生成器为SDK创建完善的文档。为了支持Visual Studio的F1功能,其中一个输出是MS Help Viewer格式。问题是,当我们将该包安装到Help Viewer 1.0(Visual Studio 2010)或Help Viewer 2.0(Visual Studio 2012)中时,文档没有放在根容器中 图中显示的“API引用”节点是类库本身的容器。虽然我们可以重命名此节点,但这样做不会为我们留下任何位置,以便在类库引用之外包含概念性内容。将

Documentation 在自己的javadoc中集成javadoc

是否可以将JDK自己的文档集成到我的项目文档中 因此,在示例中,我基本上希望java.lang.Stringjavadoc链接到我自己的文档。您可以使用@see和{@link}注释来引用javadoc类 /** * {@link java.lang.String} * @see java.lang.String */ 如果您想要在线javadoc的链接,请使用以下链接: /** * @see <a href="http://docs.oracle.com/javase/

Documentation 是否有将标记导入trac wiki实例的方法?

我一直使用trac wiki来维护一些文档。我看过像doxygen这样的解决方案(Drupal,我们已经用这种方式对代码进行了注释),但我们也有不真正接触代码的员工 对于他们和我自己,我希望能够简单地维护一个降价文档,并定期将其导入到我们的trac实例中 考虑到trac已经使用了markdown,我想知道是否有插件可以解析markdown文档目录并自动将它们推到TracWiki中 这有什么意义吗?这种类型的插件存在吗 可以编写脚本。您可以在版本控制系统的post-commit钩子中运行脚本,也可

Documentation 当角色被单元声明时,声明程序块对它们起作用吗?

如果前面有“use”子句,它们显然没有,比如: use Foo; #| Why for Baz unit role Baz does foo; method quux { "quux"} 然后 收益率: No documentation available for type 'Baz'. 这是一个错误,还是我做错了什么 更新:reported对我来说就像一个bug。@伊丽莎白·马蒂森的问题是,它似乎影响了整个角色;无法将其用于任何其他功能。。 No documentation avail

Documentation 提到”一词;例外情况;在用户手册中

我试图将我提到的“每当应用程序由于异常处理的运行时错误而重置时”,特别是异常处理的部分,简化为哑巴。还有什么比“异常处理的运行时错误”更容易理解的术语呢?提前感谢。通常人们会使用类似于“如果应用程序遇到内部错误”的词语。通常类似于“如果应用程序遇到内部错误”似乎是人们所使用的。每当应用程序因崩溃而重置时。每当应用程序因崩溃而重置时。可能只说“运行时错误”,而不是“异常处理的运行时错误”。可能只说“运行时错误”,而不是“异常处理的运行时错误”如果是针对用户的,我更喜欢 “哎呀,你在中间抓到了。”

Documentation Markdown或其他简单标记语言中的条件逻辑?

我正在寻找一种类似减价的语言的实现,它允许我在文档中嵌入“条件逻辑” 我想该文件看起来会像: This text should be included in all processed versions of the document [platform==foo] This is an example for platform Foo [platform==bar] This is an example for platform Bar 然后,通过向处理脚本传递参数,可以生成不同版本的文

Documentation Liferay taglib文档在哪里?

我在找Liferay的taglib文档。我发现,除了自动生成的类型信息外,到目前为止我单击的每个条目都是空的 那么,我怎样才能知道Liferay中的标记满足了什么目的呢?您可以查看详细信息,也可以浏览《Liferay在行动手册》第4章,其中包含有关Liferay标记库的简要说明。链接将我引导到主页。一个类似的链接是,但我看不出这与这个问题有什么关系。本书可以作为一般概述,但没有参考。标记库的详细说明不可用,但出于参考目的,您可以检查它是否有用,此外,在liferay.com上,没有为所有标记库提

Documentation Django Rest框架:如何记录获取更少端点?

我的同事实现了一个API,该API只允许使用ID参数获取请求(因此我可以获取/foo/5,但无法获取/foo/)。如果我试图在不提供ID参数的情况下访问API的端点,它(正确地)会抛出一个未实现的异常 我想修复此端点,以便在通过web查看文档时不带ID地显示其文档。然而,我仍然希望它在通过编程访问端点时抛出异常 正如我所记得的,django rest框架能够区分这两种情况(通过请求头),但我不确定如何定义端点,以便它根据需要返回文档HTML或异常 有人能为这一点提供模式吗?根据描述,我猜端点是一

Documentation Doxygen与汇编语言

我想使用Doxygen来记录混合了C和x86汇编语言的遗留代码。汇编语言不是内联的,而是在单独的仅汇编文件中。如何记录汇编语言部分?请参阅本手册的问题12。您处理的是纯汇编文件,还是C源代码中的内联汇编?假设是前者,您必须编写一个输入过滤器,将汇编代码转换为类似C的代码(更容易),或者编写一个新的解析器(更难)。Doxygen常见问题解答的问题12最终让我找到了一个看起来很有希望的方法。它将汇编代码转换为Doxygen可以解析的C语言。谢谢 原来的似乎已经死了。然而,早在2008年,我就拿出了一

Documentation 沙堡/新界北。将平台图标和版本信息添加到帮助文件页面

我正在使用Sandcastle帮助文件生成器为我的库构建帮助文件。该库有三个版本(.NET、Silverlight和windowsphone7),它们都是从同一个代码库构建的 我想在帮助文件页面底部的方法名称和版本信息旁边添加平台图标。类似于下面的截图。如何将这些信息添加到帮助文件中 这个问题在Sandcastle论坛上得到了回答 保罗·塞洛米(Paul Selormey)写了一篇非常详细的三部分博客,讨论了如何做到这一点: 谢谢。但不幸的是,我似乎需要很长时间才能将他的建议融入SHFB流

Documentation 如何方便地放置板条箱';是最新的文档吗?

我最近在crates.io上发布了我的第一个板条箱,我想知道我是否可以更轻松地维护它的文档 GitHub页面上托管了相当多的板条箱文档,所以我想我可以试一试。我创建了一个user.github.io repo,用cargo doc生成文档,并将它们推送到其中。一切正常,可以从crates.io查看文档 但是,更新它们很不方便;如果我修改板条箱的文件,我需要: 将这些更改推送到板条箱的回购 通过cargo doc 将文档文件移动到GitHub页面的文件夹中 将文档推送到文档的回购 我很确定我做得不

Documentation 如何在文档中并排显示代码和伪代码?

我想在一个页面上显示代码,在它旁边的另一列中显示一些psuedo代码——因此它看起来像两个单独的文档并排显示。向下滚动时,两列/文档应保持锁定状态。我该怎么做 背景:如果您有兴趣了解原因,请参阅: 我们正在为客户机做代码表示,因为代码包含复杂的数学,必须在逻辑上精确。客户精通数学,但编程技能较低。因此,我想在相邻的一列中显示伪代码,以便非常容易地遵循算法的总体方向。没有人提出过任何建议。我考虑过生成PDF,但我找不到一种不使用word wrap的简单方法来生成文档 我最终使用的是GitHub。这

Documentation 该公司坚持在我们的所有文档中使用二进制格式

我在一家公司工作,出于某种原因,该公司坚持我们的所有开发文档都应采用MS Word格式。这是一种二进制格式,意味着我们不能: 文档的不同版本相互冲突(因此同行评审是一件痛苦的事情——因为我们所处的领域,所有更改的同行评审都是必不可少的) Grep一个包含关键字文档的文件夹 您使用什么编写文档?为什么 另外,请给我弹药来改变这种情况……我们使用维基(特别是Trac提供的维基)的原因有两个。另外,如果我们真的需要,我们也可以获取标记的文本版本,并在纯文本环境中对其进行操作(例如,在提交期间作为s

Documentation 编写技术规范的过程

我有点担心这可能是重复的,但我已经搜索了该网站,我能找到的每个问题似乎都更关注功能规范,而不是技术规范 我在寻找关于如何沟通应该如何做,而不是应该做什么的信息。我认为在最简单的层面上,我正在寻找最好的方法来帮助初级程序员解释实现功能规范的正确方法 关于文档的大多数答案似乎都假设,一旦给出了详细的需求列表,开发人员就会知道实现它的最佳方法,我倾向于发现情况往往并非如此。到目前为止,我找到的最好的资源似乎是Steve McConnell的10*软件开发,但我想知道是否还有其他人有一些有用的答案 我建

Documentation 软件项目的文档

我和一个团队一起工作,这个团队致力于一个非常大的软件项目,我们有大量以MS WORD格式编写的文档,没有超链接索引,没有搜索能力。 每天我们都在浪费时间寻找准确的文件或参考资料 我在想,是否有一种方法,或者甚至是一种专业的工具,可以将所有这些转换成wiki格式,或许在一点手动(痛苦)帮助下,可以组织成一些可以提高可访问性的东西。 我使用谷歌桌面搜索让我的生活变得更轻松,但这不是最好的解决方案 我只想知道你们中是否有人遇到过类似的问题和可能的解决方案。不知道将MS Word转换为Wiki的工具,但

Documentation 如何确保文档显示备用的#ifdef';d代码

我正在开发一个跨平台的库。有些代码依赖于平台,因此我必须使用#ifdef来分离它们,并检查平台类型。我将一个类分为两个类,每个类都有自己的平台。这些类有不同的名称,但最后我需要typedef根据平台将这些类划分为一种类型: #ifdef UNIX /** some comment */ typedef Key_unix Key; #elif WIN /** another comment */ typedef Key_win Key; #endif 生成的文档仅显示带有两个注释的第一个type

Documentation 语义Ui中可用变量的综合列表?

在语义Ui中是否有一个全面的变量列表,列出了所有可以自定义的内容?像@floatingBoxShadow,@iconSize等。从1.0版开始,您最好检查位于semantic/src/themes/default/的默认主题文件夹。在globals/site.variables中,您会发现站点范围内的变量类似于Bootstrap,但相似之处仅限于此。每个集合、元素、模块和视图都有自己的变量与之关联

Documentation Nexus DB报表设计器中使用了什么风格的对象Pascal?

我使用一个名为RentalDesk NX的软件,它构建在Nexus DB之上。根据报表设计器的帮助手册,我需要用Object Pascal编写代码,但我在网上找到的引用函数(如RightStr、StrToDate或YearOf)似乎都不起作用 我一直在为我的会计部门写一份报告,但找不到一个好方法来计算日期。有没有人对什么资源对我有帮助有什么见解 我已经交叉发布到RentalDesk NX用户社区。RentalDesk NX报告引擎基于数字隐喻的报告引擎,请参阅 《开发者指南》可以帮助RBDeve

Documentation 我的硕士论文题目是;&;“如何维护它”;

我必须提交我的研究提案,我很困惑从哪里开始写我的提案。我应该在研究方法部分使用哪种类型的方法。有什么办法可以维护未记录的代码吗?听起来你可能想与处理未记录代码的人进行访谈/问卷调查。也许可以跟踪源代码存储库中随着时间的推移发生了什么(与未记录的代码库相比,代码库中有多少更改被提交给了有文档记录的部分?)。因此,开源项目可能是一个良好的开端。我曾在商业环境中工作过,在那里许多编码人员基本上没有文档记录,但可能很难找到愿意公开谈论这些示例的人,更不用说交出回购访问权了 关于解决方案,根据我的经验,任

Documentation 如何在流程图中表示中断(针对微控制器)?

有人有任何可视示例吗?您必须有一个单独的中断处理流程图。流程图用于显示控制流程,中断就其本质而言是控制流程的中断。我将建立一个有限状态图,表示控制的正常状态和中断状态;每个状态都是一个块级元素,包含一个流程图类型的图表。通常,在没有任务操作系统或库的情况下,中断只是标记一个变量,然后影响流程。我认为@JustJeff是对的。根据流程图结构,让中断源于一个节点/框而不是另一个节点/框可能最有意义,因为根据定义,中断不是从正常的软件流中产生的(除非是软件触发的中断)。将其放在单独的流程图上,或者与流

Documentation 导出要静态服务的Go文档有什么技巧吗?

我想使用godoc生成的文档静态地(在AppEngine上)为我创建的项目提供服务。我看到godoc启动了一个服务器,显然包文档都是动态生成的。但是,是否有将文档保存到文件系统的解决方法,或者我还有什么其他选择?如果您正在使用GitHub,那么已经有了一个非常好的项目: 文档在页面的底部。它是开源的,只需稍加努力,就可以让它从非GitHub服务生成文档

Documentation 为什么尽管“GENERATE\u LATEX=NO”,Doxygen仍然执行pdftex?

我有一个相当大的C/C++项目,只想由Doxygen生成文档的HTML版本。在我的doxy文件中我已经写了 GENERATE_LATEX = NO 实际上,指定的输出目录中没有latex目录;只需html。但是,我在stderr上获得了pdfTex的输出: ... This is pdfTeX, Version 3.1415926-1.40.11 (TeX Live 2010) restricted \write18 enabled. entering extended mode (./_f

Documentation 在重组文本中粗体字的一部分

如何在重组文本中使单词的一部分加粗 下面是一个我需要的示例:“.rst代表重新构造的文本。”我很惊讶您不能简单地编写 .rst stands for **r**e**s**tructured **t**ext. 但事实上,声明内联标记后面必须有空格或-,:?”)或,因此上面的重构文本字符串无效。但是,只需稍作更改即可通过反斜杠转义获得有效。将上面的更改为 .rst stands for **r**\ e\ **s**\ tructured **t**\ ext. 很好。若要看到这一点,请尝试

Documentation 如果Doxygen语言只支持访问器,如何在Doxygen中记录属性?

在C/C++中,我通常需要记录一个属性,而不仅仅是它的访问器(getter和setter)。一些文档系统直接支持这一点,例如GTK文档。但是我怎样才能用强力剂做到这一点呢 我在getter中描述了属性,但它肯定不是解决方案。在getter和setter中复制描述更糟糕 典型的C示例,其中Obj是不透明的: /** *盖特博士 */ int getSize(Obj*Obj); /** *二传手文件 */ 无效设置大小(Obj*Obj,整数大小); //在何处放置大小文件? 您可以这样做: clas

Documentation 开发人员文档生成器

我正在尝试以以下方式为我的web应用程序构建开发人员文档: 我正在寻找的特性是,它有一个左侧垂直导航栏,文档文本和代码部分位于右侧。我不是从头开始创建HTML/CSS,而是想知道是否有一个网站生成器,可以用来拖放我想要的功能,如垂直导航栏、代码块等,或者其他方法来构建此类文档

Documentation DataContractSerializer文档

我正在寻找DataContractSerializer的深入文档/操作指南。谷歌找到了很多相关的文章,但我没有发现什么。(我不是在找工作) 有一点澄清:我从未在.NET中使用序列化,但有一个可以工作的应用程序,我需要更新/修改它。我有一个相当好的主意,如果我设计了序列化系统,我将如何做我需要做的事情,但我不想通过一堆MSDN类文档寻找他们希望我如何做。MSDN的东西可以很好地解释某些东西是如何工作的(谷歌也是如此,因为在这一点上,你对谷歌有一个特定的术语),我想要的是一个很好的“这里是它的工作原

Documentation 代码中需要记录哪些项目?

每种编程语言中都有许多选项,可以在代码文档中提及 我想知道我们必须记录的最重要的项目是什么?我想记录合同。此参数不应为null,此函数从不返回null。。。以及这种方法的意义。。。。除了记录API之外,我还会对代码片段添加注释,这些代码非常重要,但会为应用程序增加重要的价值。这些代码隐晦但速度非常快,可以解决框架错误 您记录的内容最终取决于谁将阅读该文档

Documentation 是否可以处理MainPage.dox以外的页面

如果将MainPage.dox文件放在Doxygen的搜索路径中,它会将其添加到源文档上方的Doxygen/html输出中。但是你能有多个像MainPage.dox这样的文件吗?还是只限于一个 Doxygen将识别和解析任何扩展名为*.dox的文件,并将其包含在生成的文档中。这些文件将产生的内容由文件中的doxygen注释决定。例如,如果要修改主页面,则需要如下注释: /** * @mainpage * Documentation you want to occur on the main

Documentation Doxygen\sa外部名称空间中的链接

我有两个c#类文件,都在不同的名称空间中。我想知道当我试图引用的方法存在于另一个命名空间中时,如何在我的注释中放置Doxygen\sa“See Also:”链接 我的例子如下: File1.cs namespace namespace1 { public partial class class1 { /*! \brief My Description for PublicFunction * \sa namespace2.cla

Documentation 如何将WebWorks ePublisher与持续集成服务器集成?

我们的文档是使用手动创建的。我们希望在我们的CI服务器上自动构建它 为此,应该有一个非交互式命令行替代ePublisher GUI 有人知道这件事吗?我想你应该看看名为的WebWorks ePublisher组件 发件人: ePublisher AutoMap是一种自动化工具,使您能够自动化内容转换过程、批处理以及与内容管理或版本控制系统的集成。此组件允许您计划ePublisher项目。例如,您可以计划在夜间生成输出。然后,当您第二天早上到达时,您转换的内容就为您准备好了。您还可以自动生成和部署

  1    2   3   4   5   6  ... 下一页 共 6 页