zoukankan      html  css  js  c++  java
  • 代码规范体会篇

    前言:这是好几天前的一个流水账的日志类型,今天发布我也懒得修改其中的许多错误了,有进来看的不要见怪啊

    笔记(2月6号):
    与赵畅大佬合作的刚开始,分配了一些工作,首先来了一次完成这次作业的工作大致安排。由于大佬的经理比我的多多了,因此,主要由大哥带领我完成此次作业。
    就先说这次的第一个任务分配吧,不做不知道,一做吓一跳,我的任务是将我们此次作业的代码规范整理好,说实在话,因为之前对于这种代码规范没有丝毫的接触,在一开始大哥和我说的时候,特意还给了我一份他找来的代码规范模板(虽然我自己要找的话也会找,但是我没有去找),而仅仅是这份代码模板规范,才只是刚开始让我心惊。大哥要求我在规定的时间完成,真的在一开始的时候真的不知道要怎么制定好一份属于我们这次的作业的代码规范,我把我的第一份大妈规范给大哥看了之后,(结果是什么样的相信大家应该也猜的出来的),然后大哥稍微详细的给我解释了一下这个代码规范应该怎么去制定,稍微更懂了一些的我就开始返工做第二次,我半懂的再一次修改了我们的代码规范,然后交给大哥去审查下,(估计是大哥实在看不下去我的效率了),结果虽然是比第一次好一点,肯定是还有一些没有做好的,终于,大哥自己动手给我示范的修改了一段,让我模仿着完成接下来的代码规范,哎,有了这样的一个提示,最后我们也算是终于把我们的代码规范给定了下来。
    而这些前面说的一点点还只是这次的做代码规范的任务的大致过程。。。
    接下来再好好说一下具体做这几次代码规范的艰辛过程:
    1.代码规范之第一阅:首先大哥给了我一份他找来的某个公司的代码规范的模板,我们的代码规范就是根据这个定出来的。一开始不知道具体要怎样做这份代码规范的时候,我是一段一段的把这份长达几十页的代码规范认真的看完了,虽然后面会发现这个过程效率比较低,没有把其中的主要的我们用的上的总结出来,但是!这次的认真阅读了一份代码规范之后,收获那可不是一两句话可以解释的。举几个例子吧:程序缩进,对齐用空格键而不用tab键等等(这只是第一节的排版中的小收获)还有第二节的注释,第三节的标识符命名,第四节的可读性中的很多内容。
    2.代码规范之第二改:经过,第一次大哥稍微详细的说了一下怎么做代码规范之后,虽然还不是非常理解的我还是继续加以修改,这个过程,我又把这一整篇代码规范看了一遍,就和前面一样的了,那些平时不怎么注意的细节记住了,还有一些压根就不知道的也学到了,同时还解决了几个以前就有疑问的点呢,比如说不能用tab 因为不同的编译器或是其他的可能会导致乱码这个点以前就一直有一些纳闷。
    3.第二篇虽然相对更好了一些,但是还是不够简洁,不适合我们这次的作业所需要满足的代码规范,经过大哥直接的给我演示了一小段制定过程之后,我终于还是把这份代码规范做的像样了,之后再给大哥做了一些校对和补充。(比如函数名,变量名的命名要用驼峰法编名)
    第一个任务之总结:收获分两块,一个是做任务本身的收获,另一个就是和大佬合作的收获了(我觉得是十分重要)。
    简要概述:
    任务:做每一件任务的那些前期工作都是自己可以事前准备的。懂得了很多以前没有注意到的代码规范细节,让我在平时编写代码的时候会多注意这些。另外一个就是在完成一个任务的过程中,经常会遇到一些不如意的事情,甚至会有很多次需要重新返工开始,不能每一次都是半懂的就开始下一次,在开始每一次的时候都一定要比上一次好很多,有更大的把握之后再去重新开始,才能以最好的方法,最有效的方式做好。(就比如说这些的代码规范的任务,我写了三次,第一次的修改就差不多是白废,什么都没有理解就开始做,花了很很长时间但效果却非常低,第二次的修改虽然比第一次好一点,但是也是没有理解好本次代码规范的本质,做出来只是比第一次多删除了一些而已,而第三次才真正的明白该怎么做,最后才做好这次我的任务,估计大佬对我的工作效率也是很无奈啊)

    合作:完成本次大佬安排的任务之后,很明显的就发现我的办事效率是很低的,一份代码规范的任务我做了三次,每次还是需要大佬的提示该怎么做。所以经过此次的合作之后,对于与人合作的那种说不清的关系我还是收获了非常多的

    2月11号:
    经过一个晚上的查阅之后,这几天大佬几乎已经把这次的作业所需要的点都打完了,我也知道他用的应该大部分就是C++,在我对于C++的并没有很熟的情况下,我觉得情况是很危急的,我必须自己再用C语言去把大致的思路写出来,必须有我自己的的编码思路,过程。
    显然一晚上的查阅没有结果是很让人心烦的,也即是这样,恰好大佬过来询问了,毫无疑问就给了我一波心灵鸡汤,原本不舒服的心里也舒坦多了,很感谢大佬的不断支持,这次合作真的非常棒,接下来还有几天,一定要好好的用心去编写!
    大佬带领完成作业过程所教
    1.代码规范中的要求记忆的知识点:
    A.程序块要采用缩进风格编写。对齐之能用空格键,不用Tab,缩进的空格数为4个。(说明:对于开发工具自动生成的代码可以有不一致,使用Tab有可能会导致缩进格式编排混乱)

    B.相对独立的程序块之间,变量说明之后必须加空行。(便于让人理解这是分开的模块)

    C.注释格式尽量统一,建议使用/......../,语言尽量统一(全英文或中文),为了更准确的表达意思以及后续阅读方便,建议统一使用中文。

    D.标识符命名尽量要准确,清晰,明了,尽量使用英文全名或是易懂的缩写,或者一些特殊约定或缩写。有需要时,应加以注释。

    E.对于变量,函数,数组等命名,采用以下规则:

    变量:采取小驼峰法,除第一个单词之外,其他单词首字母大写。
    例如 int myStudentNum;

    函数名、类名:采取大驼峰法,所有单词首字母大写。
    例如 class DatabaseUser;

    数组名:采取小驼峰法,并且用下划线分隔单词。
    例如 char rand_Operator[4];

    graph LR
    A-->B
    
  • 相关阅读:
    Time Zone 【模拟时区转换】(HDU暑假2018多校第一场)
    HDU 1281 棋盘游戏 【二分图最大匹配】
    Codeforces Round #527 (Div. 3) F. Tree with Maximum Cost 【DFS换根 || 树形dp】
    Codeforces Round #527 (Div. 3) D2. Great Vova Wall (Version 2) 【思维】
    Codeforces Round #527 (Div. 3) D1. Great Vova Wall (Version 1) 【思维】
    Codeforces Round #528 (Div. 2, based on Technocup 2019 Elimination Round 4) C. Connect Three 【模拟】
    Avito Cool Challenge 2018 E. Missing Numbers 【枚举】
    Avito Cool Challenge 2018 C. Colorful Bricks 【排列组合】
    005 如何分析问题框架
    004 如何定义和澄清问题
  • 原文地址:https://www.cnblogs.com/heihuifei/p/6405358.html
Copyright © 2011-2022 走看看