| 网站首页 | 业界新闻 | 小组 | 威客 | 人才 | 下载频道 | 博客 | 代码贴 | 在线编程 | 编程论坛
欢迎加入我们,一同切磋技术
用户名:   
 
密 码:  
共有 3512 人关注过本帖
标题:帮助文档怎么写啊
只看楼主 加入收藏
wyb19850616
Rank: 6Rank: 6
来 自:大连
等 级:贵宾
威 望:29
帖 子:3172
专家分:126
注 册:2006-10-3
结帖率:66.67%
收藏
 问题点数:0 回复次数:13 
帮助文档怎么写啊
我做了一个计量系统
可是里面的帮助文档我不知道该怎么写了
用什么格式啊 怎么来实现啊
谢谢了
搜索更多相关主题的帖子: 文档 
2006-12-28 15:28
千里冰封
Rank: 16Rank: 16Rank: 16Rank: 16
来 自:灌水之王
等 级:版主
威 望:155
帖 子:28477
专家分:59
注 册:2006-2-26
收藏
得分:0 

不太清楚

你只要能交待清楚你的程序怎么用应该就可以了吧


可惜不是你,陪我到最后
2006-12-28 15:34
wyb19850616
Rank: 6Rank: 6
来 自:大连
等 级:贵宾
威 望:29
帖 子:3172
专家分:126
注 册:2006-10-3
收藏
得分:0 
以下是引用千里冰封在2006-12-28 15:34:16的发言:

不太清楚

你只要能交待清楚你的程序怎么用应该就可以了吧

我 知道你的意思
文字叙述谁都可以完成
只是具体代码怎么实现我不太明白 就是说 怎么才能把我描述的文字写进去 而且是帮助文档格式
老千又麻烦你了


多年以后我就会很老了  腰间那柄玄铁剑也换成了木剑 我拖着它浪迹天涯    我一生打败了无数江湖豪客    然而   却打不败逝者如斯的时光和对你无尽的思念
2006-12-28 15:55
千里冰封
Rank: 16Rank: 16Rank: 16Rank: 16
来 自:灌水之王
等 级:版主
威 望:155
帖 子:28477
专家分:59
注 册:2006-2-26
收藏
得分:0 

你在写程序的时候按照标准的格式来写,然后用javadoc命令,它会自动帮你生成帮助文档,格式就像JAVA API的格式一样

你可以把你的源代码改改
每个方法都加上注释


可惜不是你,陪我到最后
2006-12-28 16:00
wyb19850616
Rank: 6Rank: 6
来 自:大连
等 级:贵宾
威 望:29
帖 子:3172
专家分:126
注 册:2006-10-3
收藏
得分:0 
老千你 写程序时如果用得上帮助文档 你怎么写啊
说说你怎么写的就可以了
最好把你的代码给我复制上来
我看看

多年以后我就会很老了  腰间那柄玄铁剑也换成了木剑 我拖着它浪迹天涯    我一生打败了无数江湖豪客    然而   却打不败逝者如斯的时光和对你无尽的思念
2006-12-28 16:03
千里冰封
Rank: 16Rank: 16Rank: 16Rank: 16
来 自:灌水之王
等 级:版主
威 望:155
帖 子:28477
专家分:59
注 册:2006-2-26
收藏
得分:0 

[CODE]/*
* testHelp.java
*
* Created on 2006年12月28日, 下午4:18
*
* To change this template, choose Tools | Template Manager
* and open the template in the editor.
*/
/**
*
* @author lbf
*/
public class testHelp {
private String name;
/** Creates a new instance of testHelp */
public testHelp() {
}

/**
* 此方法用于打印传入的字符串
*/
public void printString(String s){
System.out.println("String:"+s);
}

/**
* 此方法用于返回字符串name
* @return name
*/
public String getName(){
return name;
}

/**
* 用于设置名字name
*/
public void setName(String name){
this.name=name;
}
}[/CODE]

这是一个很简单的程序,你注释的时候,按上面的格式注释

然后javadoc testHelp.java就可以了

他会自动为你生成API的文档


可惜不是你,陪我到最后
2006-12-28 16:25
wyb19850616
Rank: 6Rank: 6
来 自:大连
等 级:贵宾
威 望:29
帖 子:3172
专家分:126
注 册:2006-10-3
收藏
得分:0 
以下是引用千里冰封在2006-12-28 16:25:12的发言:

[CODE]/*
* testHelp.java
*
* Created on 2006年12月28日, 下午4:18
*
* To change this template, choose Tools | Template Manager
* and open the template in the editor.
*/
/**
*
* @author lbf
*/
public class testHelp {
private String name;
/** Creates a new instance of testHelp */
public testHelp() {
}

/**
* 此方法用于打印传入的字符串
*/
public void printString(String s){
System.out.println("String:"+s);
}

/**
* 此方法用于返回字符串name
* @return name
*/
public String getName(){
return name;
}

/**
* 用于设置名字name
*/
public void setName(String name){
this.name=name;
}
}[/CODE]

这是一个很简单的程序,你注释的时候,按上面的格式注释

然后javadoc testHelp.java就可以了-->老千这个怎么执行啊 ,什么意思啊,我不太明白 没用过!!

他会自动为你生成API的文档


多年以后我就会很老了  腰间那柄玄铁剑也换成了木剑 我拖着它浪迹天涯    我一生打败了无数江湖豪客    然而   却打不败逝者如斯的时光和对你无尽的思念
2006-12-28 16:47
千里冰封
Rank: 16Rank: 16Rank: 16Rank: 16
来 自:灌水之王
等 级:版主
威 望:155
帖 子:28477
专家分:59
注 册:2006-2-26
收藏
得分:0 

在CMD里面执行就可以啊

在DOS里面执行那个命令就行了

就像我们编译JAVA文件要javac testHelp.java一样


可惜不是你,陪我到最后
2006-12-28 16:55
wyb19850616
Rank: 6Rank: 6
来 自:大连
等 级:贵宾
威 望:29
帖 子:3172
专家分:126
注 册:2006-10-3
收藏
得分:0 
以下是引用千里冰封在2006-12-28 16:55:59的发言:

在CMD里面执行就可以啊

在DOS里面执行那个命令就行了

就像我们编译JAVA文件要javac testHelp.java一样

可我用的是JBuilder啊 怎么运行啊


多年以后我就会很老了  腰间那柄玄铁剑也换成了木剑 我拖着它浪迹天涯    我一生打败了无数江湖豪客    然而   却打不败逝者如斯的时光和对你无尽的思念
2006-12-28 17:09
千里冰封
Rank: 16Rank: 16Rank: 16Rank: 16
来 自:灌水之王
等 级:版主
威 望:155
帖 子:28477
专家分:59
注 册:2006-2-26
收藏
得分:0 

抛开它不用,直接进DOS里面去运行

要么就在JB里面找一找,应该有自动根据注释生成DOC的方法,因为NetBeans也有


可惜不是你,陪我到最后
2006-12-28 17:13
快速回复:帮助文档怎么写啊
数据加载中...
 
   



关于我们 | 广告合作 | 编程中国 | 清除Cookies | TOP | 手机版

编程中国 版权所有,并保留所有权利。
Powered by Discuz, Processed in 0.040424 second(s), 7 queries.
Copyright©2004-2024, BCCN.NET, All Rights Reserved