相信大家刚开始写代码的时候就被前辈告知了要养成写注释的好习惯，今天我们来了解一下如何利用我们平时写的注释生成文档，一起来看看吧！

其实注释格式一般如下两种： 

/* 

*普通多行 

*注释 

*/

// 单行注释

而我们需要生成文档就必须是下面这种格式： 

/** 

*javadoc 

*要求格式 

*/ 

其实就是多了一个*号而已。

既然了解了注释的格式，那么我们就利用上面的注释来使用android studio生成javadoc：



 单击进入配置页面：



 这里我主要讲以下几个地方： 

首先在上面指定你需要生成文档的文件夹或文件； 

然后是output directorys中指定输出文档的路径； 

最后如果你注释中是中文就需要在Othere command line arguments中填写 -encoding utf-8 -charset utf-8 否则生成会失败并提示你“编码GBK的不可映射字符”，好了基本上流程就走完了，直接点击ok即可。



当你看到和我一样的界面那么你就成功了，我这里是生成了所有类的文档，如果没有自动打开网页，大家可以在我们指定的文档输出文件夹中找到index.html打开即可，好了本文就到此为止，希望对大家有用！

Android Studio javadoc 生成注释文档的更多相关文章

  1. 利用JSDOC快速生成注释文档，非常棒。

    有时往往我们需要建一个文档来记录js中的一些代码注释,比如一些公共的函数,又或者一些类,在团队合作中,文档接口也是必不可少的,传统的方式多少有些不便,这里介绍一个工具,它叫JSDOC,它可以用来将注释 ...

  2. 使用doxygen生成注释文档

    1. doxygen下载地址:http://www.stack.nl/~dimitri/doxygen/ 2. 参考http://wenku.baidu.com/link?url=ETvBUyaR9f ...

  3. Doxygen给C程序生成注释文档

    近段时间,一直在学习华为C语言编程规范(2011版),在“注释”这一章中发现了一种“Doxygen”的注释转文档工具,查看诸多相关资料,并进行编程实践,终于可以利用Doxygen给C程序生成注释文档. ...

  4. （转载） android studio library生成jar包和aar的方法总结

    android studio library生成jar包和aar的方法总结 标签: android学习文档jar和aar的使用与生成gradle 2016-11-25 10:39 1782人阅读 评论 ...

  5. javadoc 生成帮助文档时，注意以下几点

    参考:http://www.w3school.com.cn/tags/tag_pre.asp javadoc 生成帮助文档时,注意以下几点: 1.函数功能描述的结尾一定要有句号,英文句号或中文句号均可 ...

  6. Android Studio单独生成apk

    /********************************************************************* * Android Studio单独生成apk * 说明: ...

  7. （转载） Android studio如何生成aar包

    Android studio如何生成aar包 标签: Android studio如何生成aaAndroid studio aarAndroid 如何生成aar包 2016-12-21 14:42 1 ...

  8. [Dynamic Language] 用Sphinx自动生成python代码注释文档

    用Sphinx自动生成python代码注释文档 pip install -U sphinx 安装好了之后,对Python代码的文档,一般使用sphinx-apidoc来自动生成:查看帮助mac-abe ...

  9. 在eclipse中生成html注释文档

    生成api文档 文档注释/** 1.描述 2.@author 作者 @version 版本 3.@param 参数 @return 返回值的含义 @throws 抛出异常描述 @deprecated ...

随机推荐

  1. Provider

    import React from 'react';import PropTypes from 'prop-types'; class Provider extends React.Component ...

  2. 二、bootstrap缩略图幅

    一.bootstrap缩略图幅

  3. PHP微信红包生成算法的程序源码（用抛物线的模型实现）

    代码如下: <?php /* * 红包生成随机算法 */ header("Content-type:text/html;charset=utf-8"); date_defau ...

  4. Spring解决循环依赖

    1.Spring解决循环依赖 什么是循环依赖:比如A引用B,B引用C,C引用A,它们最终形成一个依赖环. 循环依赖有两种 1.构造器循环依赖 构造器注入导致的循环依赖,Spring是无法解决的,只能抛 ...

  5. Android中的ImageView的scaleType属性详解

    ImageView的Scaletype决定了图片在View上显示时的样子,如进行何种比例的缩放,及显示图片的整体还是部分,等等. 设置的方式包括: 1. 在layout xml中定义android:s ...

  6. 双目立体匹配经典算法之Semi-Global Matching（SGM）概述：匹配代价计算之互信息（Mutual Information，MI）

      半全局立体匹配算法Semi-Global Matching,SGM由学者Hirschmüller在2005年所提出1,提出的背景是一方面高效率的局部算法由于所基于的局部窗口视差相同的假设在很多情况 ...

  7. kvm无人值守安装centos6

    nginx配置 server { listen default_server; server_name _; root /home/iso; # Load configuration files fo ...

  8. [CSP-S模拟测试]:斯诺(snow)（数学+前缀和+树状数组）

    题目传送门(内部题37) 输入格式 第一行一个整数$n$,表示区间的长度. 第二行一个长度为$n$的只包含$0,1,2$的字符串,表示给出的序列. 输出格式 一行一个整数,表示革命的区间的数量. 样例 ...

  9. 阿里云Redis 配置

    查看路径whereis redis 1.修改配置文件 vim /etc/redis.conf 这三个配置是必须的 修改内容,把 daemonize no 修改为:daemonize yes requi ...

  10. 为什么要用getBaseContext()方法代替this？（转）

    问:this 常常引用当前的 context.但是有些时候,必须使用getBaseContext()来代替this.就是说使用this会引发错误. 如下面的例子: Spinner spinner = ...