编写规则 注意事项和手册|学习笔记

简介: 快速学习编写规则 注意事项和手册。

开发者学堂课程【Scala 核心编程-基础编写规则 注意事项和手册】学习笔记,与课程紧密联系,让用户快速学习知识。

课程地址:https://developer.aliyun.com/learning/course/609/detail/8888


编写规则 注意事项和手册

 

内容介绍

一、正确的注释和注释风格

二、正确的缩进和空白

三、Scala 官方编程指南

四、知识回顾

 

接着上节内容讲解文档注释:

文档生成指令是:

scaladoc -d d:/ Hello.scala 生成对应的文档说明。

上节本身是在函数下方写的注释,如下:

/**

*@deprecated 过期

*@example


*输入n1=10 n2= 20 return 30


*@param  n1

*@param  n2

*@return 和



*/

但生成注释的时候找的是 looksourcecode,所以没有生成。在 comment 右键点击 show in explorer 找到文件,在地址栏输入 cmd 回车,在执行框里输入

scaladoc -d d:\mydoc2 comment.scala 

在地盘中找到生成的文件打开 index.html

注释中的内容已经生成了,所以没有问题

image.png

一、正确的注释和注释风格

带看 Scala 源码

 

二、正确的缩进和空白

1使用一次 tab 操作,实现缩进,默认整体向右边移动,shift+tab 整体向左移

2或者使用 ctrl + alt +L 来进行格式化[演示]

比如代码有点乱,可以用格式化进行处理。

3运算符两边习惯性各加一个空格。比如:2 + 4 * 5。

4一行最长不超过80个字符,超过的请使用换行展示,尽量保持格式优雅

var str = "hello" + "hello"+ "hello"+ "hell0"+ "hell0"+

"hell0"+"hell0"+ "hello

比如这里有很多拼接指令,不停往后面添加的情况下,这时候要注意换行,包括有些时候函数是连着用的,也要注意换行。

 

三、Scala 官方编程指南

在做一个开发的时候不用编程手册是不行的。

 image.png

这就是官方手册,在左侧有很多深色的一栏,这就代表一个包,点开后就可以看到包里面有什么类、接口等等。

比如想对 hashmap 有个了解,就可以在左上方搜索框里搜索

hashmap,显示在 scala.collection.immutable

scala.collection.mutable 两个包里都有 hashmap,说明有两种不同的 hashmap。

随便点开一个可以看到里面有 hashmap 的很多类型成员、值成员等等,下方有很多方法。

点开另一个可以看到有很多接口和继承关系。

包括类型的继承关系,里面有一张图,可以看出 hashmap 是从哪来的,继承了哪些类又实现了哪些接口都可以看到,比较方便。

用的时候可以在左上角搜索框里搜索关心的类或者接口,在下方点击就可以在右方看到相应的方法和成员。

 

四、知识回顾

1Scala 语言的 sdk 是什么?

Scala 本身有开发库,这个开发库和 Java 的 JDK 库关系用一个图来描述:

image.png

2Scala 环境变量配置及其作用。

(1)配置 SCALA HOME 比如放在d 盘下面的某个目录:=d:/program

(2)配置 Path=%%  //这里将前面的环境变量引用一下,后面带上目录:Path=%SCALA  HOME%\bin

3Scala 程序的编写、编译、运行步骤是什么?能否一步执行?

编写:就是使用工具,开发 scala 程序

编译:就是将.scala 文件编译成.class [scalac]

运行:就是使用 scala 来将.class 文件加载到 jvm 并运行

可以直接运行.scala,但是速度慢  cmd>scala xx.scalaq

4Scala 程序编写的规则。

Scala 程序编写的规则基本上规范和 Java 类似,但是语句后面不需要加上分号。

在代码后面带了一个分号也不会报错,只是软件会觉得多余。

现在很多语言后面都不带分号,比如 js 后面也是可以不带分号的。

5、简述:在配置环境、编译、运行各个步骤中常见的错误。

相关文章
项目编写时的注意事项
标签(空格分隔): 个人总结 最近学了很多知识点,也通过几个作业、项目将这些知识点串联在一起,相互协作完成一个程序丰富的功能。 在写项目的时候,最大的困难是没有一个很好的编写流程。虽然对于项目的每一个功能都可以单独的分析并提出解决方法和思路,也可以写出对应的知识点来完成此功能。
|
3月前
|
安全 网络协议 Linux
本文详细介绍了 Linux 系统中 ping 命令的使用方法和技巧,涵盖基本用法、高级用法、实际应用案例及注意事项。
本文详细介绍了 Linux 系统中 ping 命令的使用方法和技巧,涵盖基本用法、高级用法、实际应用案例及注意事项。通过掌握 ping 命令,读者可以轻松测试网络连通性、诊断网络问题并提升网络管理能力。
266 3
VC++中subclassdlgitem函数的功能、用法及注意事项
subclassdlgitem   该函数用来子类化一个控件.   Subclass(子类化)是MFC中最常用的窗体技术之一。子类化完成两个工作:一是把窗体类对象attach到一个windows窗体实体中(即把一个窗体的hwnd赋给该类)。
1342 0
|
数据库 前端开发 JavaScript
|
Scala 开发者
包的使用细节和注意事项2|学习笔记
快速学习包的使用细节和注意事项2。
|
Java 程序员 Scala
包的使用细节和注意事项1|学习笔记
快速学习包的使用细节和注意事项1。
119 0
包的使用细节和注意事项1|学习笔记
|
Java 数据安全/隐私保护 开发者
函数的注意事项| 学习笔记
快速学习函数的注意事项
|
9月前
|
存储 数据处理 API
【C# 控制台】主要讲述以下C#的部分语法,部分基础,做到了解作用
【C# 控制台】主要讲述以下C#的部分语法,部分基础,做到了解作用
103 0

热门文章

最新文章

相关实验场景

更多