JAVA代码文档化高手进来帮个忙,谢谢!

来源:百度知道 编辑:UC知道 时间:2024/05/18 10:51:40
下面这段代码是教务管理系统中的一段,需要加上详细的注释,我只加上了部分的注释,希望高手能帮忙完善一下,小妹定将加分感谢!
package tju.business.services;
import java.util.ArrayList;

import tju.business.*;
import tju.business.vo.*;
import tju.dao.DAOInterface.*;
import tju.dao.exception.DataAccessException;
import tju.dao.factory.DAOFactory;
/**
* @作者 管理员
*
* TODO To change the template for this generated type comment go to
* Window - Preferences - Java - Code Style - Code Templates
*/
/**
*系统的这块是一个学生信息服务类,包括的操作有学生信息的
*增加、删除、修改、查询及人数统计几个方面。
*/
public class StudentInfoService {

private StudentInfoService(){
}
/**
*管理员进入“管理学生信息”页面
*/
public static StudentInfoService getInstance(){
return new StudentInfoService();
}
/**
*新增学生信息,获取学生信息插入列表
*/
public boolean addStudent(StuinfoVO student) throws DataAccessException{
DAOFactory df=DAOFactory.getDAOFactory();
Stuin

//后面可以写中文,
/**
*
*/
一般里面是版本注释,作者,还有

* @param c
* @return
* @throws DataAccessException
这种的,介绍参数,返回值什么的,最好别写中文。

/*
*
*/
写方法描述,完成什么功能,实例的。

/** 这是什么啊!
你看看java的doc就知道了!

注释还要找别人啊~!!!!

/**
*管理员进入“管理学生信息”页面
*/
public static StudentInfoService getInstance(){
return new StudentInfoService();
}
你的这个就不对了。看代码就知道是创建一个StudentInfoService 的实例 返回一个StudentInfoService啊!
注释的话 如果代码是自己写的 那么每个方法是做什么用的自己写写就好了啊,因为你给出的这个类 还使用了其他的的类。有些业务逻辑只有你能知道的!