代码规范-标准化注释-iOS VVDocumenter

最新推荐文章于 2022-05-25 11:01:30 发布

BeTheBestOne

最新推荐文章于 2022-05-25 11:01:30 发布

阅读量463

点赞数

分类专栏： iOS技术文章标签：注释 ios开发 iOS注释

本文链接：https://blog.csdn.net/u011347072/article/details/52015245

版权

iOS技术专栏收录该内容

22 篇文章 0 订阅

订阅专栏

代码规范是老生常谈的事儿啦，当然少不了标准化的注释，我接触到的iOS开发者用的最多的当属VVDocumenter，如果有更好用的，别忘了分享哦~

Xcode文档代码注释工具vvDocumenter

<span 插件下载：<="" span="">https://github.com/onevcat/VVDocumenter-Xcode

安装：运行下载的vvDocumenter工程,重启Xcode

使用：方法前面输入///，自动生成注释框架，修改对应说明

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

BeTheBestOne

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录

ABAP的代码规范标准

SAP BLOG--Jack Wu

08-24

3921

iOS编程比较好开源的完整项目iOS编程比较好开源的完整项目

m0_67912190的博客

03-25

3444

完整项目 GSD_WeiXin高仿微信 v2ex- v2ex 的客户端，新闻、论坛。 V2ex-Swift- 用 Swift 写的 V2EX 客户端。 iBBS-Swift- “新手开源一个用Swift（2.0）写的论坛客户端”。BBS 服务端。 wikipedia-ios- wikipedia-ios 客户端。 jetstream-ios- 一款 Uber 的 MVC 框架。它同时提供了多用户实时通讯支持，一旦启动 JetStream 后端服务，通过 WebSocket 协议可以分...

参与评论您还未登录，请先登录后发表或查看评论

pycharm文件头规范和函数注释自动生成

Hanscal

05-25

3083

优雅规范的注释有助于对代码理解，易于与人合作开发，提高效率。但若没有自动化的注释会让写注释耗时耗力。可以自动生成功能和用途简介、参数、返回值、创建人、创建时间、修改人、修改时间、版权声明、异常抛出。下面介绍在 pyCharm中使用两种方式的注释： 1. 文件头规范自动生成在文件头加上创建人、创建时间、修改人、修改时间、版权声明；有些规范建义这些元素写在文件头部。可通过如下方法设置： File->Settings->Editor->File and Code Templates

Java注释规范整理

gyhgc的专栏

08-06

1205

在软件开发的过程中总是强调注释的规范，但是没有一个具体的标准进行说明，通常都是在代码编写规范中简单的描述几句，不能作为一个代码注释检查的标准和依据，做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》，内容来自网络、书籍和自己的实际积累。 JAVA注释规范版本/状态作者版本日期 1.0 ghc 2008-07-02 一、背景 1、...

ABAP开发规范

zcy691640的专栏

07-29

3447

ABAP开发规范目录 1 ABAP对象命名规范 6 1.1 开发类 6 1.2 程序名 6 1.3 数据字典 7 1.3.1 表/结构/数据元素/域 7 1.3.2 表类型 7 1.3.3 范围表类型 7 1.3.4 搜索帮助 7 1.3.5 锁对象 7 1.4 函数组及函数模块 8 1.4.1 函数组 8

代码注释规范化

JOY兜兜的博客

06-12

778

代码使用过程中使用到注释是必要步骤，以下就几种注释以及其规范化进行讨论。程序语言注释笔记：一、注释的分类C语言中注释方法有多种例如：//、/* */、#if 0等注释，下面就新手都使用过的//注释提出一些个人想法。1.//注释，用于代码尾，优点是易于使用，编码时，简单的单行注释进行注释的时候，键盘的操作相对更为简单一点。在许多菜鸟到大佬的过度过程中都被使用到过，这种单行注释的风格被认为是从C++中...

转：Objective-C规范注释心得

圣昊liu的专栏

01-08

823

转载摘要：最初对代码注释方式起注意是在用百度地图SDK时注意到的，后就在模仿其注释方式。近一段又在做第三方登录功能，看了微博SKD、微信SDK和腾讯SDK 看到他们使用的注释方式也有稍微的差异，就开始看相关的文章，感觉这篇来自博客园的zyl910写的这篇文章很好，就粘过来备份下。另外还有同行推荐一款规范注释生成器VVDocumenter 也相当好用－－ https://gi

iOS 代码规范

禹泽的专栏

08-18

836

一、命名规范命名规则对于维护代码来说是非常重要的,。Objective-C方法名往往很长，不过这也有好处，让很多注释变得毫无意义。1、驼峰法 Objective-C社区的标准，驼峰法分小驼峰法和大驼峰法。小驼峰法：除第一个单词之外，其他单词首字母大写，一般用于变量命名。大驼峰法相比小驼峰法，大驼峰法把第一个单词的首字母也大写了，一般用于对象命名。2、基本原则1）清晰（可读性高）又清晰又简洁是...

XCode6 快速加注释

07-16

Xcode的这个特性尤其对大型项目和团队协作来说至关重要，因为它促进了代码的标准化和一致性。 VVDocumenter-Xcode 是一个针对Xcode的插件，它基于Apple的Doxygen工具，能够帮助你快速生成符合Apple官方文档风格的...

Xcode自动注释插件

01-14

总之，VVDocumenter-Xcode是一个强大的Xcode自动注释插件，它能提升开发者的代码注释效率，让代码更易于理解和维护。合理利用插件，可以显著提高开发团队的工作效率，同时也为后续的代码审查和文档生成提供便利。

iOS：iOS开发非常全的三方库、插件等等

dienangpiao2051的博客

09-23

7418

iOS开发非常全的三方库、插件等等 github排名:https://github.com/trending, github搜索：https://github.com/search. 此文章转自github:https://github.com/Tim9Liu9/TimLiu-iOS 一、UI 下拉刷新 EGOTableViewPullRefresh- 最早...

iOS开发全套资源，从入门到全栈IOS工程师

hellolizi的博客

09-14

1967

内容介绍：本内容涵盖框架、组件、测试、Apple Store、SDK、XCode、网站、书籍等。发起者来自vsouza，由jobbole提供中文编译。文章以下内容主要是分享面经和个人的学习建议，内容涉及到很多PDF文档（面试题库、学习笔记、实战文档、脑图等），由于文章有限，需要这些文档的，直接（点击我）免费领取入门 Road Map iOS：开发 iOS 应用从今天开始，苹果指南。 Lifehacker：我想写一个 iOS 应用，该从哪里开始？ Codeproject：入门 iPhone 和 iOS

详细：idea如何设置类头注释和方法注释

热门推荐

u013412790的专栏

10-13

28万+

idea和eclipse的注释还是有一些差别的。idea:类头注释：打开file->setting->Editor->Filr and Code Templates->Includes->File Header 直接在右边的文件框里编辑你说需要注释的东西，然后应用保存之后,当你创建类的时候就会自动生成注释。方法注释：打开file->setting->Editor->LiveTemplate

如何使用Doxygen为C添加标准化注释

胖大星的博客

08-05

2493

转载请注明出处http://blog.sina.com.cn/u/1580340211 自己之前没有注意我的代码规范，现在回过头去看简直一塌糊涂，决定以后规范自己的代码编写，尤其是注释部分，因为其对于代码重用十分重要，doxygen免费又方便，所以在学opencv的时候应该可以作为我规范化编码的首选工具。【了解Doxygen】按照参考手册上说的，Doxygen目前可以支持的

iOS UILabel复制粘贴效果

u011347072的博客

10-30

9082

在iOS中下面三个控件，自身就有复制-粘贴的功能： 1、UITextView 2、UITextField 3、UIWebView UIKit framework提供了几个类和协议方便我们在自己的应用程序中实现剪贴板的功能。 1、UIPasteboard：我们可以向其中写入数据，也可以读取数据。UIPasteboard类提供了粘贴板的接口。粘贴板是用

reference to 'Size' is ambiguous, candidate found by name lookup is 'Size', 'cv::Size'

u011347072的博客

11-30

6533

这两天在iOS端集成OpenCV的时候，遇到reference to 'Size' is ambiguous, candidate found by name lookup is 'Size', 'candidate found by name lookup is cv::Size' 的问题（同理rect 也有同样的问题），因为不熟悉c++，找了好久的原因。刚找到解决办法，迫不及

iOS －数据持久化－文件的写入（简单对象和复杂对象）

u011347072的博客

09-17

5337

数据持久化的本质－数据保存成文件，存储到程序的沙盒中－在应用程序结束时，将内存中的数据以文件的形式搬到（保存到）硬盘中沙盒机制(Sand box):是个安全机制－这就是ios和Mac系统安全的原因，就是因为它采用了沙盒机制越狱之后沙盒机制被损坏了，应用程序之间可能会相互盗取信息沙盒其实

UIButton，设置button的背景图片

u011347072的博客

10-30

2573

UIButton UIButton *aButton = [UIButton buttonWithType:UIButtonTypeSystem]; //给按钮设置frame aButton.frame = CGRectMake(0, 0, 200, 80); //为按钮设置标题－常用的是Normal和Highlighted －标

iOS开发：代码规范与最佳实践

“iOS代码规范.pdf”是一份关于iOS开发中的编码规则和最佳实践的文档，旨在确保代码的可读性、可复用性和可维护性。这份规范涵盖了多个方面，包括代码抽象、命名、注释、属性和变量的使用、格式规范以及其他重要的...