`
tianjun309
  • 浏览: 372774 次
  • 性别: Icon_minigender_1
  • 来自: 深圳
社区版块
存档分类
最新评论

一般文档都会出现的约定(方便大家伙看行业文档)

 
阅读更多

格式             意义
粗体               命令行关键字(命令中保持不变、必须照输的部分)采用加粗字体表示。
斜体               命令行参数(命令中必须由实际值进行替代的部分)采用斜体表示。
[ ]                表示用“[ ]”括起来的部分在命令配置时是可选的。
{ x | y | ... }    表示从两个或多个选项中选取一个。
[ x | y | ... ]   表示从两个或多个选项中选取一个或者不选。
{ x | y | ... }*  表示从两个或多个选项中选取多个,最少选取一个,最多选取所有选项。
[ x | y | ... ]*  表示从两个或多个选项中选取多个或者不选。
&<1-n>             表示符号“&”前面的参数可以重复1~n次。
#                 表示由“#”开始的行为注释行。

分享到:
评论

相关推荐

    软件需求详细设计文档模板.docx

    文档约定部分规定了编写文档时遵循的标准和约定,如部件编号方式、界面编号方式和命名规则等。这些约定确保了文档的一致性和可读性,便于团队成员之间进行有效的沟通。 #### 五、预期读者和阅读建议 这部分内容针对...

    MFC中单文档与多文档使用总结

    ### MFC中单文档与多文档使用总结 #### 重要概念与区别 MFC(Microsoft Foundation Classes)作为Visual C++中的一个重要的类库,提供了丰富的功能来帮助开发者快速构建Windows应用程序。在MFC中,单文档界面(SDI...

    软件开发文档 详细设计说明书 图书管理系统

    软件开发文档详细设计说明书图书管理系统 本资源摘要信息是关于软件开发文档详细设计说明书图书管理系统的知识点总结,从标题、描述、标签和部分内容中提取关键信息,并对其进行详细解释和分析。 一、软件开发文档...

    软件需求文档全套(全套)

    软件需求文档(全套)软件需求文档(全套)软件需求文档(全套)软件需求文档(全套)软件需求文档(全套)软件需求文档(全套)软件需求文档(全套)软件需求文档(全套)软件需求文档(全套)软件需求文档(全套)...

    Openai Api开发文档 - Openai Api中文文档 - Openai Api中英双语文档

    Openai Api开发文档 | Openai Api中文文档 | Openai Api中英双语文档 ChatGPT是由OpenAI开发的一个人工智能聊天机器人程序,于2022年11月推出。该程序使用基于GPT-3.5架构的大型语言模型并通过强化学习进行训练。 ...

    计算机软件文档编制规范GB T-8567-2006 word版

    3. **文档格式与表达**:规范强调文档的清晰性和一致性,规定了文字表述、图表使用、符号约定等格式标准。这有助于提高文档的可读性和专业性,减少理解上的歧义。 4. **版本管理与更新**:文档应随着软件开发进程...

    UE4官方中文文档.rar

    此外,提供的CHM文件(Compiled Help Manual)是一种离线帮助文件格式,用户可以在无网络的情况下查阅文档,方便快捷。而`.rar`文件则可能是压缩后的文档或更新包,需要使用解压软件才能访问其中的内容。 总之,...

    QT帮助文档_中文版_QT中文版帮助文档_

    对于数据库操作,Qt提供QSqlDatabase和相关的QSql*类,可以方便地连接和查询各种数据库系统,如MySQL、SQLite等。 此外,文档中还会包含Qt的国际化和本地化支持,如QLocale和QTranslator,帮助开发者创建多语言的...

    互联网产品经理文档模板

    首先,我们来看[PRD]产品需求文档(Product Requirements Document)。这是产品经理向开发团队传达产品概念的关键工具,通常包含产品目标、功能描述、用户故事、优先级排序以及预期成果。PRD应清晰、简洁,以便所有...

    MSDN帮助文档中文.zip

    MSDN(Microsoft Developer Network)是微软为开发者提供的一系列技术文档和资源的综合平台,它包含了微软各种操作系统、开发工具、编程语言以及框架的详细信息。这个“MSDN帮助文档中文.zip”压缩包文件显然是一个...

    接口文档模板.docx

    接口文档在软件开发中起着至关重要的作用,它定义了不同系统或组件之间的通信规则,确保数据能够准确、高效地传递。以下是一个详尽的接口文档模板及其关键知识点的解析: 1. **接口文档的基本结构** - **接口名称*...

    layui官方离线文档

    4. **API接口**:layui提供了一系列的JavaScript API,用于控制和操作组件,如表格的增删改查、弹窗的打开关闭等,方便开发者进行动态交互。 5. **主题定制**:layui允许用户自定义主题,通过修改CSS变量,可以轻松...

    pinpoint 中文使用文档,供大家学习

    另外,文档作者还提供了一些中文翻译的文档链接,比如快速开始(Quick Start)、安装指南(Installation Guide)、插件示例(Plugin Samples)、告警(Alarm)等。 综上所述,Pinpoint是一个功能强大的APM工具,...

    国家标准软件开发文档模板————可以帮助一些不喜欢些项目文档的或者是不知道怎么写文档的朋友解决很大的问题!~试试看

    国家标准软件开发文档模板是指导软件开发过程中的重要参考资料,它为开发者、项目经理和团队成员提供了规范化的写作框架,确保了项目文档的完整性和一致性。这些模板涵盖了从项目启动到最终交付的各个阶段,包括需求...

    华为SmartMX_MA5620配置文档(word版本).

    文档约定规定了文档编写过程中需遵循的规则和标准,包括但不限于术语定义、符号表示法、图表样式等,以保证文档的统一性和易读性。 #### 六、文档的发行、申请与反馈 - **发行方式**:可通过华为官方网站下载电子...

    软件开发文档模板(最全)

    本文将深入探讨“软件开发文档模板(最全)”所涵盖的几个核心部分:需求文档、设计文档和开发文档,以及它们如何在软件生命周期中发挥作用。 1. **需求文档**: - 需求分析报告:详细描述软件应实现的功能和非...

    C#操作Word文档(根据模板生成文档、替换内容、插入表格等)

    在IT行业中,C#是一种广泛使用的编程语言,尤其在开发Windows桌面应用和.NET框架相关项目时。本主题聚焦于如何利用C#来操作Microsoft Word文档,包括根据模板生成文档、替换内容以及插入表格等核心功能。这对于自动...

    java的API接口文档模板

    Java API接口文档模板详解 Java API接口文档模板是Java初学者必须掌握的重要知识点之一。该文档模板提供了详细的接口输入输出定义,旨在帮助前后端开发人员快速了解和使用接口。下面我们将对该文档模板进行详细解释...

    Android API中文文档

    Android API 中文文档 Android API 中文文档 Android API 中文文档 Android API 中文文档 Android API 中文文档 Android API 中文文档 Android API 中文文档 Android Android API 中文文档 中文文档Android API ...

    CesiumAPI文档离线版

    CesiumAPI文档离线版是开发者必备的参考资料,尤其在无法访问官方网站时,它能确保开发工作不受网络状况的影响。 Cesium API主要由以下几个核心部分组成: 1. **Cesium Viewer**: 这是Cesium的核心组件,负责渲染...

Global site tag (gtag.js) - Google Analytics