代码注释用途

1. 什么是代码注释?

程序员在代码中加入的辅助说明信息,不能被计算机执行,也不受语法约束,可以在里面写入任何内容。

2. 为什么要注释代码?

一般来说,注释用来帮助程序员记录程序设计方法,辅助程序阅读

每当我们学习别人的代码时,常常感觉像在看文言文,心里想着找作者问问这脚本都是什么意思;也别提看别人的了,有时候看自己一个星期前写的脚本都得花费好长时间,才能弄懂其中一两行代码的目的。

所以说脚本中的注释不仅可以辅助他人阅读,更重要的是方便我们以后查看。毕竟一个逻辑清晰、代码优秀的脚本,自己看着也很有成就感。

3. 如何进行代码注释?

单行注释以#开头;多行注释以```/---开头和结尾

4. 需要注释哪些内容

对脚本的说明,比如脚本是什么时候写的、主题是什么、内容是什么、注意标明作者和邮箱(方便与他人进行交流);对代码的说明,比如包的用途、函数的用途、代码的内容…

最后来几行我的必写代码感受下

脚本的前几行用来注明时间主题内容作者以及邮箱

---
time: ----/--/--
title: ""
keywords: "","","","",""
author: Phoenix_Z
e-mail: zyfeng1996@163.com
---

脚本的最后,记得保存运行环境和历史记录,下次打开编辑器加载一下,emmm...我们的Rstudio还是原来那味。

setwd("~/filename/sub_filename")#设置运行环境
getwd()#获取当前运行环境

#保存运行环境和历史记录
save.image("~/filename/sub_filename/Environment.RData")
savehistory("~/filename/sub_filename/History.Rhistory")

#加载环境和历史记录
load("~/filename/sub_filename/Environment.RData")
load("~/filename/sub_filename/History.Rhistory")

对一些重要的、难懂的代码用#进行注释说明。总之一句话,对我们的代码要有始有终有交代

©️2020 CSDN 皮肤主题: 游动-白 设计师:上身试试 返回首页