开发者学堂课程【Scala 核心编程-基础：文档注释】学习笔记，与课程紧密联系，让用户快速学习知识。
课程地址：https://developer.aliyun.com/learning/course/609/detail/8887
文档注释
内容介绍
一、注释介绍
二、Scala 中的注释类型
一、注释介绍
用于注解说明解释程序的文字就是注释，注释提高了代码的阅读性;
注释是一个程序员必须要具有的良好编程惯。将自己的思想通过注释先整理出来，再用代码去体现。
小故事：
以前有两个学生基础都差不多，甚至有一个同学基础还好一点，结果到了一年后，原先基础不是很好的同学很快就当上项目经理了，另一个基础比较好的同学还在当程序员，导致这种情况的原因是：
成长比较快的同学说他写代码时有一个习惯，因为项目比较多，文件很多，在写完代码后加上注释，注释写的比较规范。
另外一个同学一点注释都不写，这样的后果是这些代码除了自己能看懂，其他人虽然能看懂但是耗费时间很长。
比如别人看带有注释的代码，一天可以把项目看一个大概，没有注释就很难看懂。
二、Scala 中的注释类型
1、单行注释
2、多行注释
3、文档注释
文档注释：
创建一个 object 类型的文件名称为 comment，比如里面有一个主函数，然后简单写一段话，下方再写一个求和的函数如下：
package com.atguigu.chapter01
object comment {
def main( args: Array [string]): unit = {
println( "he1lo,world! ")
}
def sum(n1: Int,n2 : Int) : Int = {
return n1 +n2
}
现在要做一段注释，一般来讲注释用的比较多的是在函数上写一个：
package com.atguigu.chapter01
object comment {
def main( args: Array [string]): unit = {
println( "he1lo,world! ")
}
/**
*@deprecated过期
*@example
* 输入ni = 10 n2 = 20 return 30
*@param n1
*@param n2*
*@return和
*/
def sum(n1: Int,n2 : Int) : Int = {
return n1 +n2
}
这样做的目的是让别人一看就很清晰。
将它做成一个文档，做成文档注释首先找到这个文件的所在地，右键点击 show in explorer 找到源码，在地址栏输入cmd 执行，执行一个指令就可以了：
1、输入 scaladoc， 这是专门生成文档的。
2、接着输入 scaladoc-d d:/mydoc 将其存放在 d 盘的文件夹中。
3、然后对哪一个 class 文件进行 doc 文档注释呢？
在第二步基础上接着输入 look 回车会自动生成
looksourcecode.scala
进入d盘会看到会自动生成一个文件夹里面有了 index.html 双击打开点击 looksourcecode.scala 会发现有了相应的东西了，注释、函数都有，这样就可以用了。
