[发明专利]项目文档编制和编辑的翻译观察器

说明书

技术领域

本发明一般涉及软件开发系统，尤其涉及提供替换口头语言翻译以便于用与项目相关联的当前口头语言的翻译和文档编制的界面视图。

背景技术

软件文档编制或源代码文档编制是伴随计算机软件的编写文本，并且通常在计算机开发环境中创建。通常，这种文档编制说明基础代码如何操作和/或如何使用该代码。术语软件文档编制具有一个以上的上下文，因此以不同形式存在。文档编制的一些示例类型包括软件的架构或设计文档。另一种形式包括代码、算法、界面和API的技术文档。其它形式的文档包括终端用户、系统管理员、技术支持职员的指南以及包括产品摘要和宣传信息的销售手册。

设计文档趋于作一总览。该类文档更加注重为什么，而不是描述如何使用。例如，在设计文档中，程序员可说明以特定方式组织数据结构背后的基本原理，或者列出特定对象的元函数和如何向代码添加新对象。这可包括说明以特定方式创建给定类的原因、概述模式、讨论替代设计、概述改进方案、或提供以后如何针对未来项目改进设计的计划。然而，该类文档编制通常并不被视为适合通过考虑其它要求而设计的代码或技术文档编制。

对于技术文档编制，这是大多数程序员在使用术语软件文档编制时考虑的一类信息。当创建软件时，代码自身是不够的。应该具有与代码一起的一些文本以描述其预期操作的诸方面。该文档编制通常嵌入到源代码自身内，所以很容易被遍历它的任何人访问。在一情形中，可向源代码添加高度技术化并主要用于定义和说明API、数据结构和算法的注释。例如，可使用该文档编制说明变量指代工厂中特定位置或机器。代码文档的详尽非常重要，但是不必冗长以致于变得难以维护。除了源代码文档编制之外，其它技术文档编制的要求包括有关任务、例程、控制器、模块、数据类型、标签(tag)、状态(phase)、内插式(add-on)指令等的描述。

通常，诸如Doxygen、javadoc、ROBODoc、POD或TwinText的工具可用于自动生成代码文档-即，它们从源代码提取注释并以文本或HTML文件形式创建参考手册。代码文档通常组织成参考指导样式，从而允许程序员快速查找任意函数或类。许多程序员出于各种原因习惯了自动生成文档编制的观念。例如，由于从源代码自身(例如通过注释)提取，因此程序员可在引用他们的代码时编写它，并且因而可使用用于创建源代码的同一工具来生成文档编制。

除了标准的文档编制任务，目前系统针对全球经济市场开发。因此，不仅需要用于代码或系统开发的母语的文档编制，而且通常要求将文档编制翻译成除初始代码开发语言之外的一种或多种外语。随着软件项目开发持续国际化，用户需要在相应设计的消费者语言与该设计创建者语言不同的全球范围内使用软件或系统设计。因此，开发工程师、维护工程师和观看设计的操作员可能使用不同的语言，这对需要更新、更改、和/或操作给定设计的人会产生问题。

发明内容

以下提出简化概要以便于提供对本文所述一些方面的基本理解。该概要不是广泛概观，也不旨在识别关键/重要元件或者描绘本文所述诸方面的范围。其唯一目的是以简化形式提出一些概念作为稍后呈现的更详细描述的序言。

提供一种翻译观察器以便于可将一种以上的口头语言用于系统或项目的文档组件的系统或项目文档编制。在许多情形中，软件开发者设计并实现(开发)将在存在诸如德语、法语和英语之间差异的语言差异的一个以上国家使用的系统。因此，非常期望能够向开发项目中的组件添加文档编制，该开发项目允许以多种语言提供文档编制，使得该系统在最终使用时系统用户可观看其母语的相应文档编制或注释。在一方面，开发者以诸如英语的第一语言向组件指派注释，其中诸如英语的第一语言被设定为向项目中输入注释或文档编制的当前语言。基于已开发或已输入到项目中以支持第一语言文档编制的先前语言翻译，使对项目提供的附加注释与已与项目相关联的先前注释协调一致也是合乎需要的。

翻译观察器提供自动化界面，该界面毫无妨碍地示出对给定组件存在的其它翻译、同时允许以当前选定语言进行文档编制编辑。因此，在一示例中，如果开发者尝试以第一语言注释当前组件而且开发者还熟悉替换语言，则翻译观察器在显示器上提供替换语言的注释、同时允许以当前语言进行编辑。这样，以当前语言添加的注释可与以替换语言提供的先前注释协调一致或同步。作为另一特征，翻译观察器提醒设计者存在其它语言的注释的可能性，并且该信息可用作设计者的队列，使得替换语言注释需要就可能在项目的当前所选文档编制语言中发生变化而言进行调整。