A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

 找回密码
 加入黑马

QQ登录

只需一步,快速开始

© 金兴 中级黑马   /  2012-4-6 22:10  /  4158 人查看  /  10 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

java文档的注释     利用javadoc工具生成的文档 注释 ??我怎么感觉这个作用不是很大呢??求解?

10 个回复

倒序浏览
。。。。。。偶感觉很有用
回复 使用道具 举报
你给别人发一个工具  里面的内容只有你自己知道
别人不知道里面有什么工具.....你就要告诉别人这个class能干什么
就需要一个注释文档
回复 使用道具 举报
文档相当于使用说明书。可以说是对使用者非常有帮助的存在
回复 使用道具 举报
它的作用就好比jdk帮助文档是一样的,只有这个文档我们才知道jdk中内置什么类,类有什么方法属性等等,这些类方法属性都是干嘛用的,比较String 中的SubString 方法在这个文档中会告诉开发者这个方法是用来提取字符及如何提取。同样我们在开发程序的时候,写DOC文档,我们在日后升级及其他用途的时候,我们就很方便的知道当时写什么类方法属性及它们的作用,不然几万条代码去查找就很麻烦了。
回复 使用道具 举报
你给别人发一个工具  里面的内容只有你自己知道
别人不知道里面有什么工具.....你就要告诉别人这个class能干什么
就需要一个注释文档

楼上解释的很好!老毕老师,视频上就是这么讲的!
参见:黑马程序员_毕向东_Java基础视频教程第06天-05-面向对象(帮助文档的制作javadoc).avi
回复 使用道具 举报
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。
回复 使用道具 举报
编译成说明文档,提高程序的可读性,如果没有这些,那么你的程序基本上就是废品了。。。
回复 使用道具 举报
      帮助文档可以说是面向客户的。站在客户的角度,我需要知道你提供的产品,比如说这里基础视频中的class文件,我知道它是一个工具,有一定作用,但要想知道我能拿它做什么,就必须有一个说明解释的东西,javadoc生成的文档就是这个东西的表现形式之一。
    当然,对大部分程序员来讲,可能都是查阅API,查别人提供的帮助文档。在实际开发项目中,能参与制作这个文档的,说明你有一定水平和层次了,毕竟我相信大部分人工作都是编程写代码,做文档的事情较少接触,但这并不说明它没有用。
    楼主的感觉可以理解,作为还在学习基础技术的我们,先建立起对帮助文档的这一概念的意识,等以后学到一定水平后,肯定会有直接作用的~~
回复 使用道具 举报
java的API知道吧!!

javadoc的作用就是可以用来制作你自己的特有API
回复 使用道具 举报
pray 高级黑马 2014-4-26 03:30:33
11#
本来我已经对这个社区失望了,觉得这个社区没有前途了,心里充满了悲哀。但是看了你的这个帖子,又让我对社区产生了希望。是你让我的心里重新燃起希望之火,是你让我的心死灰复燃,是你拯救了我一颗拨凉拨凉的心!本来我决定不会在社区回任何帖子了,但是看了你的帖子,我告诉自己这个帖子是一定要回的!这是百年难得一见的好贴啊!苍天有眼啊,让我在有生之年得以观得如此精彩绝伦的帖子!
回复 使用道具 举报
您需要登录后才可以回帖 登录 | 加入黑马