swift代码排版-参考

代码排版包括: 空行、空格、断行和缩进等内容。代码排版内容比较多工作量很多,但是非常重要。

空行

空行将逻辑相关的代码段分隔开,以提高可读性。下列情况应该总是添加空行:

  • 类型声明之前。
  • import语句前后。
  • 两个方法或函数之间。
  • 块注释或单行注释之前。
  • 方法或函数内的两个逻辑段之间,用以提高可读性。
  • 一个源文件的两个片段之间。

空格

在代码中有些位置是需要有空格的,这个工作量也是很大的。下列是使用空格的规范:

1.赋值符号“=”前后有一个空格。var或let与标识符之间有一个空格。所有的二元运算符,应该使用空格将之与操作数分开。一元操作符和操作数之间不因该加空格,如:++、--等。示例如下。

[html] view plain copy

print?

  1. var a = 10
  2. var c = 10
  3. a += c + d

2. 小左括号“(”之后,小右括号“)”之前不要有空格。示例如下。

[html] view plain copy

print?

  1. a = (a + b) / (c * d)

3. 大左括号“{”之前有一个空格。示例如下。

[html] view plain copy

print?

  1. while a == d {
  2. n++
  3. }

4. 在方法或函数参数之前间有一个空格,参数冒号与数据类型之间有一个空格。

推荐使用:

[html] view plain copy

print?

  1. func tableView(tableView: UITableView, didSelectRowAtIndexPath indexPath: NSIndexPath) {
  2. ...
  3. }

不推荐使用:

[html] view plain copy

print?

  1. func tableView ( tableView: UITableView, didSelectRowAtIndexPath indexPath: NSIndexPath ) {
  2. ...
  3. }

断行

一行代码的长度尽量避免超过80个字符,为了便于查看是否一行代码超出80个字符,很多IDE开发工具都可以在编辑窗口设置显示80行竖线。在Xcode中设置过程是打开菜单Xcode→Preferences,选择Text Editing标签,选中Show→Page guideat column。

由于有的代码比较长需要断行,可以依据如下一般规范断开:

  • 在一个逗号后面断开。
  • 在一个操作符前面断开,要选择较高级别运算符断开,而非较低级别运算符断开。
  • 新的一行应该与上一行缩进两个级别(8个空格)

缩进

4个空格常被作为缩进排版的一个单位,在开发时候使用制表符进行缩进,虽然默认情况下一个制表符等于8个空格,但是在不同的IDE工具中可能设置的一个制表符与空格对应个数会有所不同。在Xcode中默认是一个制表符对应4个空格,我们可以在Xcode中打开菜单Xcode→Preferences,选择Text Editing→Indentation标签,可以在Tab width中进行设置。

缩进可以依据如下一般规范:

    • 在函数、方法、闭包、控制语句、计算属性等包含大括号“{}”代码块中,代码块中的内容与首行缩进一个级(4个空格)。
    • 如果是if语句中条件表达式的断行,那么新的一行应该与上一行缩进两个级别(8个空格),再往后的断行要与第一次的断行对齐。
时间: 2024-11-04 12:25:42

swift代码排版-参考的相关文章

《从零开始学Swift》学习笔记(Day 59)——代码排版

原创文章,欢迎转载.转载请注明:关东升的博客 代码排版包括: 空行.空格.断行和缩进等内容.代码排版内容比较多工作量很多,但是非常重要. 空行 空行将逻辑相关的代码段分隔开,以提高可读性.下列情况应该总是添加空行: 类型声明之前. import语句前后. 两个方法或函数之间. 块注释或单行注释之前. 方法或函数内的两个逻辑段之间,用以提高可读性. 一个源文件的两个片段之间. 空格 在代码中有些位置是需要有空格的,这个工作量也是很大的.下列是使用空格的规范: 1.赋值符号"="前后有一个

swift 代码创建UITableView以及部分swift的讲解

1.swift创建TableView 本例子中 两个类 viewController 和SecondViewController 2.在AppDelegate创建导航条,初始化跟视图代码如图 1 func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool { 2 // Override point for cust

最详细的 Swift 代码规范指南

1. 代码格式 1.1 使用四个空格进行缩进. 1.2 每行最多160个字符,这样可以避免一行过长. (Xcode->Preferences->Text Editing->Page guide at column: 设置成160即可) 1.3 确保每个文件结尾都有空白行. 1.4 确保每行都不以空白字符作为结尾 (Xcode->Preferences->Text Editing->Automatically trim trailing whitespace + Incl

Cocos2D-ObjC:在RPG游戏中混合Swift代码

我之前写过一个RPG游戏<<熊猫之魂 SoulOfPanda>> 编译器使用的是SpriteBuilder,很好很强大!全部代码都由Objc完成,现在想尝试一下在其中混入Swift代码. 我的目的很简单,用Swift写一个GCMan9类,派生自Objc中的GameCharacter类,最后在Objc中使用GCMan9这个类. GameCharacter类是游戏人物的基类,我从中派生了十几个子类分别表示游戏主角,各种NPC,各种敌人等等. 下面是GCMan1类的头文件: #impor

使用Xcode HeaderDoc和Doxygen文档化你的Objective-C和Swift代码

在一个应用的整个开发过程中涉及到了无数的步骤.其中一些是应用的说明,图片的创作,应用的实现,和实现过后的测试阶段.写代码可能组成了这个过程的绝大部分,因为正是它给了应用生命,但是这样还不够,与它同等重要的还有代码的注释和文档编写.不管代码写的有多好,如果缺少了对应的好的注释文档,很有可能在将来带来麻烦.不幸的是,许多开发者都忽视或忽略了代码文档的重要性,而这非常糟糕,因为好的程序不仅仅是好的代码.它需要更多的东西. 谈到编写注释文档,显然我不是说仅仅简单的在实现文档里添加几行注释.肯定是更多的东

Objective中调用Swift代码

原创Blog,转载请注明出处 http://blog.csdn.net/hello_hwc 步骤比较简单: 1.在Objective C工程中,创建新文件(command+N),选择Swift文件 2.选择创建bridge-header,后会生成两个文件,一个是bridge-header(这个暂时没用,这个文件是用来将objective c中的接口暴露给swift),一个是swift文件 3.在swift中想要暴露给objective C中的类或者方法前加上@objc关键字(@objc关键字的一

Source Insight 添加代码排版和编码转换

Source Insight 提供了宏实现和命令实现. 命令实现: 1.代码排版 需要借助indent工具.可以下载GnuWin32,可以安装大多数Linux命令. indent排版很简单. 添加命令:indent.exe  -npro -nip -nlp -npsl -i4 -ts4 -sob -l80 -ss -bl -bli 0 %f %f代表当前文件. Souce Insight可以给命令添加菜单和快捷键. 2.编码转换 需要借助iconv工具.可以下载libiconv工具. iconv

Swift 2.0学习笔记——我的第一行Swift代码

Swift 2.0学习笔记--我的第一行Swift代码 当第一次看到下面代码时我石化了,这些代码是什么东东?单词拼出来的? import Foundation var str = "Hello World" print(str) 晕晕.好吧,低头继续往下看,哦明白了 第一句:import Foundation 表示引入Foundation框架. 什么是Foundation框架? Foundation是OS X和iOS应用程序开发的基础框架,它包括了一些基本的类,如数字.字符串.数组.字

Swift 2.0学习笔记——使用Web网站编写Swift代码

Swift 2.0学习笔记--使用Web网站编写Swift代码 Swift程序不能在Windows其他平台编译和运行,有人提供了一个网站swiftstub.com,左栏是代码编辑窗口,右栏是运行结果窗口.可以在任何平台下编译和运行Swift程序.