-
这是我参与「第三届青训营 -后端场」笔记创作活动的第1篇笔记 作为一名参加到这个方向的小白,首先迎面而来的一个问题就是,我能做什么,我该怎么去做。于是,我抱着不明不白的心情,开始了我的代码之路。
- 仙人们曾经讲过,不写文档者,代码虽近必忘。这点在我的coding过程中,更是频频出现。
我应该同蛮多人一样,是从学校的c语言开始入门,或者说真正的去了解,去学习一们计算机语言的,不过学校的学习当中,我们常常不会接触到我们日常开发所接触到场景或者说是习惯。
其中,我遇到的第一个问题就是:如何去写出合适的注释。我在没有系统的学习的时候,对这个概念极为模糊,甚至我回忆起来,那时我甚至觉得这个东西就是老师讲课的时候在电脑屏幕上面敲敲打打就可以了,
回头想想自己是真的年轻。
所以讲,一个好的代码 。注释,好的命名规范,是必不可少的两兄弟。
- 注释:顾名思义,是我们对于某一段语句、函数、或是一个组件的介绍,在我看来,一个好的注释,应该去尽量的做到精确,尽量的通俗易懂
不能写的及其抽象,并且出现及其遥远的抽象指向,不能去故意增加自己的不可替代性(雾),因为一方面,如果出现了一个相离很远的函数名,在未指定位置的时候,我们在回顾,或者改错调试的时候就会需要很多时候去查找这里的引用,导致时间成本大大提高,同时若这里出现了一个较为遥远的函数的调用,其实也可以考虑以下耦合性是不是过高的这样一个问题。
- 编码规范,我们可以简单的理解为,我们对于某一类功能的函数等进行的一种大家都默认遵守的一种风格,这样会很好的增加代码的可读性,减小阅读使用代码的代价。
就比如就我个人而言,可能在学习过程中,老师会起一些比较超脱的名字,比如一个单独字母的变量名,或者函数名之类的。
但是如果实际开发中要是出现这样的情况,估计接手项目的兄弟怕是想要优化了你(大雾)。
所以大家还是要保持良好的编码规范,提高自己的代码风格,写出优美的代码。
在文章的最后整理了一些文档,希望在之后,大家的编码时光能够帮助大家写出更加规范、优美的代码。
- 仙人们曾经讲过,不写文档者,代码虽近必忘。这点在我的coding过程中,更是频频出现。