Swift注释写法

相对比Java而言,Swift也提供了类似于Javadoc的内容。使用规定的注释语法来完成文档的撰写。但有点需要提及的是, Swift中的注释写法虽然能生成文档效果,但与Java的注解还是有区别的。

MARK:

该语法常用于文件结构。首字母要大写。

// MARK: - FUNC_ONE
private func displayContentOne(){
    
}

效果:在这里插入图片描述
可以看到右侧预览区高亮FUNC_ONE。

TODO:

该语法常用于未完成功能的方法或类中。

// TODO: - Need to finish
private func displayContentTwo(){
    
}

(该语法在右侧无预览)

FIXME:

该语法用于提示标记或提示有问题的地方,例如为了测试而设立的一个临时变量。

// FIXME: - At here.
private func displayContentThree(){
    
}

(该语法在右侧无预览)
以上三种语法均可使用control + 6 来查看其文件结构。示例:
在这里插入图片描述

markdown:

常用于为他人撰写文档说明。

/**

 */

在第二行(空白行)内可撰写文档。
#空一格后跟一级标题,##空一格后跟二级标题,三级标题也是如此。如下所示:

/**
 # This is test title.
 ## This is first 2rd title for test.
 ## This is second 2rd title for test.
 */

“***”用于分割线。可撰写多个分割线。
- important:空一格后跟重要描述
- returns:空一格后跟返回值
- parameter x:空一格后跟参数

全部示例:

    /**
     # This is test title.
     ## This is first 2rd title for test.
     ## This is second 2rd title for test.
     ***
     Lines 1.
     ***
     Lines 2.
     ***
     - important: This is a method just for test. And in order to test this method we will make a long setences in here.
     - returns: Void.
     - parameter x: Just for test this method.
     */
    private func displayContentFour(x: Int){
        
    }

按下option + 鼠标左键,单击某个方法名,即可出现快捷帮助窗口,示例:
在这里插入图片描述

已标记关键词 清除标记
相关推荐
【为什么还需要学习C++?】 你是否接触很多语言,但从来没有了解过编程语言的本质? 你是否想成为一名资深开发人员,想开发别人做不了的高性能程序? 你是否经常想要窥探大型企业级开发工程的思路,但苦于没有基础只能望洋兴叹?   那么C++就是你个人能力提升,职业之路进阶的不二之选。 【课程特色】 1.课程共19大章节,239课时内容,涵盖数据结构、函数、类、指针、标准库全部知识体系。 2.带你从知识与思想的层面从0构建C++知识框架,分析大型项目实践思路,为你打下坚实的基础。 3.李宁老师结合4大国外顶级C++著作的精华为大家推出的《征服C++11》课程。 【学完后我将达到什么水平?】 1.对C++的各个知识能够熟练配置、开发、部署; 2.吊打一切关于C++的笔试面试题; 3.面向物联网的“嵌入式”和面向大型化的“分布式”开发,掌握职业钥匙,把握行业先机。 【面向人群】 1.希望一站式快速入门的C++初学者; 2.希望快速学习 C++、掌握编程要义、修炼内功的开发者; 3.有志于挑战更高级的开发项目,成为资深开发的工程师。 【课程设计】 本课程包含3大模块 基础篇 本篇主要讲解c++的基础概念,包含数据类型、运算符等基本语法,数组、指针、字符串等基本词法,循环、函数、类等基本句法等。 进阶篇 本篇主要讲解编程中常用的一些技能,包含类的高级技术、类的继承、编译链接和命名空间等。 提升篇: 本篇可以帮助学员更加高效的进行c++开发,其中包含类型转换、文件操作、异常处理、代码重用等内容。
©️2020 CSDN 皮肤主题: 书香水墨 设计师:CSDN官方博客 返回首页