蒟蒻的代码规范与文档编写规范

代码规范

  1. 代码每行不得超过 80 个字符;
  2. 代码不分块、连续编写,且每一个模块不允许超过 100 行;
  3. 双目运算符运算对象与运算符之间一定要分别打一个空格,单目运算符与运算对象之间不打空格;
  4. 禁止使用 Tab 缩进,使用 2 空格缩进代码。
  5. 宏定义时没有缩进。
  6. 基本使用 Java 代码风格,如果在 forif 后只有一两个语句,尽量不使用大括号包围,如果一定要使用大括号,则尽量压行书写。
  7. 模块化的代码,提倡代码宽而短,不提倡瘦长的代码风格。
  8. 没有通用的头文件,随用随加。
  9. 尽量开局部变量,减少全局变量的使用。
  10. 大块的内存空间随用随开,用完后立即释放,并且设置为空指针
  11. 尽量使用指针书写代码,以便提高代码执行效率和可读性。
  12. 除递归调用的所有其它函数都使用 inline 以加快执行效率。
  13. 所有函数参数如非必要,均使用传址或传指针的方式,以减小拷贝构造带来常数。且能够使用 const 修饰的均应使用 const 进行修饰。
  14. 类型名的修饰符如取地址符、解指针符等采用较为随意的方式。如 node *foo(指针指向的对象)、node* &foo(需要修改指针)、node* foo(指针本来的含义) 这三种写法都是可以的。以容易理解为前提(因为不同时期的代码风格不太一样,就只有这个地方一直统一不起来)。
  15. 所有的函数名尽量采用驼峰命名法,如 readIn()。特别地,对于一些模板性的函数,则使用其较为广泛使用的名称,如 SPFATreap。对于重写的一些库函数,则使用相应的命名方式。

文档格式

好好写文档就行了。排版什么的暂时由 Han.js 负责。但是在书写时注意以下几点:

  1. 正确使用中文全角标点符号。通常习惯使用 来提高中文引号的辨识度,同时也常用分号来表示列表环境中各复句之间的关系。正确使用示例如下:

    • 中学生学科竞赛主要包括信息学奥林匹克竞赛、信息学奥林匹克竞赛、信息学奥林匹克竞赛、信息学奥林匹克竞赛和信息学奥林匹克竞赛(我就是这个样,你来打我啊)。
    • “你吃了吗?”,李四问张三。
    • 我想对你说:“我真是太喜欢你了。”
    • 「苟利国家生死以,岂因祸福避趋之!」
    • 推荐题目:「LOJ #104 普通平衡树」
    • 以下是这个算法的基本流程:
      • 第一步,初始化到各点的距离为无穷大,将所有点设置为未被访问过,初始化队列;
      • 第二步,将起点放入队列,将起点设置为已被访问过,更新到起点的距离为 \(0\);
      • 第三步,取出队首元素,将该元素设置为未被访问过;
      • 第四步,遍历所有与此元素相连的边,若到这个点存在更短的距离,则进行松弛操作;
      • 第五步,若这个点未被访问过,则将这个点放入队列,且设置这个点为已经访问过;
      • 第六步,回到第三步,直到队列为空。
  2. LaTeX 定义好了的常量与函数名直接用。所有的函数名、常量均应使用 Roman 体。
  3. 如果遇到没有预先定义好的需要使用 Roman 体的函数名,我们可以使用 \operatorname{something} 来产生,如我们可以使用:
    \operatorname{lcm}

    产生正体的最小公倍数(函数)符号:\(\operatorname{lcm(1,\,2)}\)。产生 Roman 体的常量应用 \mathrm{};其他非数学内容,包括中文、英文、特殊符号等,一律使用 \text{}

  4. 绝对不能滥用公式字体。
  5. 表示强调时请使用 **SOMETHING** 而非某级标题。
  6. 全角字符(汉字、假名、谚文等)与半角字符(英文字母、阿拉伯数字、公式)之间添加一个半角空格,特别地,对于半角字符前后出现全角标点的情况,不需要添加多余的半角空格。类似地,对于英文的半角标点,请在标点后添加一个半角空格。请参考下面的例子:

    • 对于一元二次方程 \(ax^2+bx+c=0\),我们设 \(\Delta=b^2-4ac\) 为二次方程的判别式。若 \(\Delta\le0\),则说明方程有实数根。
    • 我要把贡献者的 Pull Request 合并到 master 分支上了。
    • B 站的 22 娘和 33 娘真是太萌了!
    • The quick brown fox jumps over a lazy dog. I can eat glass, it doesn‘t hurt me.
  7. 所有用作序号的数字建议使用中文。
  8. 从不使用段首缩进这种操作。
  9. 所有用作序号的数字建议使用中文。
  10. LaTeX 的每个逗号后,都需要补上一个宽度为 0.25em 的空格 \,

测试中英文混排aaa...

原文地址:https://www.cnblogs.com/TheRoadToAu/p/9588298.html

时间: 2024-10-11 20:05:31

蒟蒻的代码规范与文档编写规范的相关文章

PHP 高级程序设计(1) - 编码规范及文档编写

PHP 高级程序设计学习笔记20140612 软件开发中的一个重要环节就是文档编写.他可以帮助未来的程序维护人员和使用者理解你在开发时的思路.也便于日后重新查看代码时不至于无从下手.文档还有一个重要的作用,在不用了解要访问对象的细节情况下也能很好的在对象之间进行交互.文档的编写有一些成熟的行业标准格式,遵守这些行业标准将有助于创建易于阅读的代表,并使自动生成手册成为可能. 编码规范 编码规范可能很多开发人员都有各自的观点也意见,且大家不尽相同.其实只要团队成员之间达成一致,遵循同一个标准就好.

HTML文档编写规范

(1)HTML标记是由尖括号包围的关键词.所有标记均以“<”开始,以“>”结束.结束的标记在开始名称前加上斜杠“/”.例如头部标记格式如下所示:<head> ……</head> (2)根据标记类型,正确书写标记,单个标记最好在右尖括号前加1个斜杠“/”,如换行标记是单个标记“<br>”,成对标记最好同时输入开始标记和结束标记,以免忘记. (3)标记可以相互嵌套(也称为包含),但不能交叉.如: <head><title>……</t

数据分析临时需求处理规范及文档管理

ps: 转自2014-11-04  数据海洋                       BI临时需求处理规范及文档管理内容一.目的规范BI处理的临时需求.便于部门同事了解业务以及借鉴. 二.临时需求的定义由业务部门向BI提出的一次性数据需求.主要用亍解决业务方某个点的问题. 三.文档的内容在临时需求处理完成后,完成以下内容,放入到共享文件夹中. 各个内容项说明需求目的:这个需求要解决业务方什么问题需求内容:指给出数据字段.规则.需求提交人:由业务部门谁向BI提交的该需求数据使用人:业务部门谁是

将Html文档整理为规范XML文档

有多种方式可以在.NET 平台进行HTML文件解析.数据提取,其中最简单.稳妥的办法是先使用工具将Html文档整理成XML文档,再通过XML Dom模型或XPath灵活地进行数据处理.SGML便是一个Html文档整理工具类库: Microsoft的XML大师Chris Lovett专门开发了一个SGML解析器,叫做SgmlReader,它可以解析HTML文件,甚至将它们转换成一个格式规范的结构. SgmlReader派生于XmlReader,这就是说,你可以像运用诸如XmlTextReader这

自己总结的C#编码规范--7.文档下载 &amp; 总结

今天终于把这一系列的编码规范写完了,这个编码规范算上前面阅读相关书籍,前前后后总共花了一个月的时间,也算是个人的呕心沥血之作了. 本来也没打算把这个系列写的这么长,但是在写的过程中自己搜了相关的网上资料,后来发现网上的c#代码规范很少,而且仅有的几份都很泛泛,没有实际的内容.所以自己就阅读了相关的书籍,自己结合自己几年来的开发经验写了这份文档.希望可以帮助那些苦于没有编码规范的程序员,也希望所有新程序员能在职业生涯的初期就有一个良好的编码习惯,这对于以后个人的成长有至关重要的作用. 在写这个规范

自己总结的C#编码规范--7.文档下载及总结

今天终于把这一系列的编码规范写完了,这个编码规范算上前面阅读相关书籍,前前后后总共花了一个月的时间,也算是个人的呕心沥血之作了. 本来也没打算把这个系列写的这么长,但是在写的过程中自己搜了相关的网上资料,后来发现网上的c#代码规范很少,而且仅有的几份都很泛泛,没有实际的内容.所以自己就阅读了相关的书籍,自己结合自己几年来的开发经验写了这份文档.希望可以帮助那些苦于没有编码规范的程序员,也希望所有新程序员能在职业生涯的初期就有一个良好的编码习惯,这对于以后个人的成长有至关重要的作用. 在写这个规范

关于文档注释规范

关于文档注释规范 准备工作: 双击打开文件夹 用editplus或其他编辑器打开 修改配置文件中: 引入配置文件: Step1:将模板配置文件放在myeclipse的安装目录下 Step2:window ---> preference Step3:导入配置文件 使用: Step1: Step2:则会自动生成注释,按上面的要求写注释 关于编码规范 参考<华为编码规范>文档. 附录: <?xml version="1.0" encoding="UTF-8&

代码操作Sharepoint文档库(创建、上传附件)

代码操作Sharepoint文档库(创建.上传附件) 做项目中遇到客户需求,根据Infopath表单生成Excel并上传到Sharepoint指定文档库中 创建文档库 SPSite site = new SPSite(siteurl); SPListItem item = site.AllWebs["网站名"].Lists["列表名"].Folders.Add("文档库URL", SPFileSystemObjectType.Folder); i

从零开始编写自己的C#框架(4)——文档编写说明

原文:从零开始编写自己的C#框架(4)--文档编写说明 在写本系列的过程中,了解得越多越不知道从哪里做为切入点来写,几乎每个知识点展开来说都可以写成一本书.而自己在写作与文档编写方面来说,还是一个初鸟级别,所以只能从大方面说说,在本框架开发所需的范围内来讲述相关要用到的知识点,至于要更深入的去了解,请大家观看其他大牛的博客或购买书籍来学习. 为了加快进度,会对目录进行修改,将一些知识点合并或在后面使用的章节再进行描述. 谢谢大家的支持,如果您觉得本文对您有所帮助,请帮忙点击支持或发表评论. 在开