文档是这样写的吗?

我还没写过文档,请问大家,是这样写的吗?

这就是我写发送邮件的那个程序的文档

位置:package com.learndiary.website.action.sendmail

整体描述:实现Runnable接口,运行在后台发送邮件的线程

成员变量:

  private ArrayList userInfoList 订阅了此目标的所有用户

private ArticleInfo articleInfo 需发送的日记

private int goalID 目标goalID

private String userNameOfWriteDiary 写日记用户的用户名

成员方法:

  public String getGoalName() 返回目标的Name

  局部变量:

  goalName = myDB.getGoalNameByID(goalID); 通过goalID返回目标的Name

        

  public void run() 线程里的run方法

  局部变量: 

  EmailAuthenticator mailAuthenticator = new EmailAuthenticator(uername,password); 获得SMTP邮件服务器认证.

  Properties props = System.getProperties();  获得系统属性

  props.put("mail.smtp.host",host); 设置邮件服务器

  props.put("mail.smtp.auth","true"); 设置邮件服务器

  Session session = Session.getInstance(props,(Authenticator)mailAuthenticator); 获得会话

  String toMail = userInfo.getEmail();  获得订阅了此目标用户的邮箱(收信地址)

  String userName = userInfo.getUserName(); 获得订阅了此目标用户的用户名

  Session session = Session.getInstance(props,(Authenticator)mailAuthenticator); 获得会话

  MimeMessage message = new MimeMessage(session);  定义消息

  message.setFrom(new InternetAddress(from)); 设置发信人

  message.addRecipient(Message.RecipientType.TO,new InternetAddress(toMail)); 设置收信人

  message.setSubject("学习日记您订阅的目标日记"); 设置消息主题

  message.setText("您好!"+userName+bodyText); 设置消息内容

  transport.connect(host,uername,password); 链接SMTP邮件服务器

  transport.sendMessage(message,message.getAllRecipients()); 发送消息

  transport.close(); 关闭连接

Author: raorao

爱CODE

One thought on “文档是这样写的吗?”

  1. 文档有很多种类,从一个项目着手到结束,其中的文档有可行性报告,需求分析,概要设计等,你所写的文档,我想应该是在代码中,把注释加在其中,到最后用javadoc生成这部分的文档,--这是我的理解

Comments are closed.