【R - 代码书写习惯、代码注释方法笔记】

前言

本篇笔记将总结R的注释方法、代码书写规范建议。干货满满！

今天突然发现自己写的代码可读性不是那么强，有的地方乱糟糟，有的时候还写一大堆注释，没有清晰的区块和条理。知错能改，善莫大焉，我去上网搜索了一些建议，写个笔记总结下，日后要积极实践，也希望能帮助到屏幕前的小伙伴，共勉！!

1.参考资料

R语言代码书写规范-知乎
Google’s R style guide
这个往前翻，还有其它多种语言的书写风格指南。
RStudio多行注释快捷键

2.代码注释

R中符号 # 用来作为注释提示符，在该行的 # 之后的都将不会被执行，只是当作注释展现，也可以写中文。
缺点是只能注释这一行，没有多行注释。但也是有解决办法滴，可以通过RStudio的快捷键弥补下。后头就讲。

2.1 代码分块

如下图所示，可以通过 4个# （也可以更多）来分块，在注释前后都加上4个#，会自动生成类似目录一样的东西，下面，右边，都可以展示，并且通过代码左边的小三角标志可以将本区块内容收起，也可以打开，可以很方便的查看各个块的代码，不用一直滑动屏幕，也可以直接点击目录，很方便。
同理，# 和 ------------的组合也能起到一样的作用，而且可能更加美观一些。

2.2 多行注释快捷键

Ctrl + shift + c
选中要注释的多行，再按上述快捷键，可一次性在多行的首位添加#。

此外 按住 alt ，并鼠标控制光标，能够在每行的相同位置添加或者删除字符，并且可以控制多行选中，以及可以上下左右移动，不得不说很nice！
同理，也可以用来注释~

3.代码书写好习惯

3.1 命名

• 变量名都小写，用 . 或 _ 分隔。一般是名词。
• 函数名，一般是动词。只有字母和数字，没有其他字符，小写字母开头，之后以首字母大写作为单词的分隔。emmm，也有不同说法，说函数名首字母大写，后边都小写，应该都可以，能好分辨就行。
• 文件名，代码文件以默认的.R结尾，也可以在开头就加上序号，就可以有清晰的阅读顺序。

3.2 符号

• 最好都使用 <- 作为赋值符号，传参时用=。
• 花括号{左边不换行，右边换行。
  }
  比如这样：
  if (y == 0) {
  log(x)
  } else {
  y ^ x
  }

3.3 空格

这个比较多情况。

• 赋值符号左右留空格。
• 加减乘除、比较判断 左右留空格。
• 逗号后加空格。
• 左括号前加空格，如if语句，除了使用函数的情况
• 冒号那些不留空格，是有特定功能的，比如用来指定函数的包的来源。
• 不要使用tab缩进，使用2空格缩进。

其它：少使用分号；少用attach()函数。

这个tab有的时候我就是懒得按空格，，用tab缩进，但两个键还是不一样的，tab在不同的情况下长度也不同，有的是4个空格，有的是8个空格，在Linux环境下也能更明显的感受到这一点。即使是同一份表格，tab的大小也可能不一样。tab是制表符，不是缩进符，不能代替空格缩进。
可以参考如下这篇文章：
python用空格还是Tab缩进

希望以后能写规范的、可读性强的代码~~
觉得有帮助可以点个赞鼓励一下哦！！