温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

C++文档结构是怎样的

发布时间:2021-11-29 11:34:41 来源:亿速云 阅读:105 作者:iii 栏目:大数据

这篇文章主要介绍“C++文档结构是怎样的”,在日常操作中,相信很多人在C++文档结构是怎样的问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”C++文档结构是怎样的”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!

本文档的结构

每条规则(指南,建议)都会包含几个部分:

  • 规则本身--例如:避免直接使用new运算符

  • 规则的参照编号--例如,C.7(于类相关的第七条规则)。由于主要分区没有自然排序,我们使用字母作为规则参照编号的第一部分。我们在编号之间留出空隙是希望将增加或者删除规则时的影响降到最低。

  • 原因(根据)-- 程序员很难在没有理解规则的情况下遵守规则。

    示例 -- 抽象的规则不容易被理解;示例可能是正面的,也可能是反面的。

  • 可选项--适用于“不要做某事”之类的规则。

  • 例外--我们提供简单而普遍的规则。很多规则虽然可以广泛应用,但并不是适用于任何情况,因此必须列出例外。

  • 实施建议--关于规则如何被“机械化”检查的建议。

  • 注意(注释)-- 无法归到其他分类却需要阐述的内容。

  • 讨论 -- 置于主规则清单之外的进一步展开的根据和/或例子。


某些规则很难被机械化检查,但是它们都符合一个标准:专家程序员可以很容易识别出违反它们的情况。我们希望“机械化”工具随着时间的推移可以尽量接近专家程序员的水平。同时我们也认为:随着时间的推移,规则会不断被完善而变得更加精确和可检查。

规则会尽量简单,而不是小心的推敲以照顾到所有的可能和特殊的情况。这类信息会在可选项段落和讨论区记述。如果你没有理解某条规则或者反对它,请参考讨论部分。

这不是一部语言手册。它当然是有用,但不是包罗万象的,也不保证所有技术细节都正确,也不是现存代码的指南。推荐的信息源可以查阅参考资料部分。

In.sec: Major sections(主要分区)

  • In: Introduction(介绍)

  • P: Philosophy(基本原则)

  • I: Interfaces(接口)

  • F: Functions(函数)

  • C: Classes and class hierarchies(类和继承)

  • Enum: Enumerations(枚举)

  • R: Resource management(资源管理)

  • ES: Expressions and statements(表达式和陈述)

  • Per: Performance(性能)

  • CP: Concurrency and parallelism(并发和相似性)

  • E: Error handling(错误处理)

  • Con: Constants and immutability(常量和不变性)

  • T: Templates and generic programming(模板和泛型编程)

  • CPL: C-style programming(C风格编程)

  • SF: Source files(源代码)

  • SL: The Standard Library(标准库)

Supporting sections:

  • A: Architectural ideas(结构方面的想法)

  • NR: Non-Rules and myths(伪规则和传言)

  • RF: References(参考资料)

  • Pro: Profiles(规则侧面)

  • GSL: Guidelines support library(指南支持库)

  • NL: Naming and layout rules(命名和布局规则)

  • FAQ: Answers to frequently asked questions(常见问题回答)

  • Appendix A: Libraries(库)

  • Appendix B: Modernizing code(现代化代码)

  • Appendix C: Discussion(讨论)

  • Appendix D: Supporting tools(支持工具)

  • Glossary(术语表)

  • To-do: Unclassified proto-rules(未完事项:未分类规则原型)

各个分区之间并非正交关系。

译者注:有可能存在重复

每个分区(例如:P代表基本原则)和每个子分区(例如,C.hier代表面向对象编程(OOP)中的类层次关系)都有一个缩略语以便检索和参照。主分区的缩略语也用于规则编码(例如,“C11”代表“让具象类型有规律”)

到此,关于“C++文档结构是怎样的”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注亿速云网站,小编会继续努力为大家带来更多实用的文章!

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

c++
AI