Javadoc - Como fazer

4 respostas
V

Não sei como descrever a documentação nessas duas Classes:

[color=green][/color]
package aluno;

import javax.swing.JOptionPane;
import menu.*;
import aluno.Programa;
/**
 * <h1 style ="color: blue"> class Aluno</h1>
 * Esta classe e respónsavel por guarda</br> as principais
 * informações dos alunos como</br>
 * nome, matricula, materias
 * e principais funções</br>
 * cadastrar, pesquisar e sair.
 * @name class Aluno
 * @author  700424Marcos, 0700499Taís, 0700542Vanessa
 * @version 0.0.3
 */
public class Aluno {
	
		
	  
	  
	  public String nome[] =new String[5];
	  
	  public int matricula = 0;
	  
	  public String materia[] = { "portugues", "matematica", "ciencias", "estudos sociais"};
	  
	  public float nota[][] = new float [10][10];
	  public float media[][] = new float[10][10];
	  
	 
	  public int qtdAluno = 0;
	  
	  public float total;
	  int c, n,i,m =0;
	  
	 
	  public int qtdAluno(){
		
			qtdAluno = Integer.parseInt(JOptionPane.showInputDialog
				      ("Digite a quantidade de alunos para cadastro"));
			c = qtdAluno;
			  System.out.println("Quantidade "+c);
			if(qtdAluno == 0){
				  JOptionPane.showMessageDialog(null, "Quantidade inválida");
				  qtdAluno();
			 }
			  else {
				  
				 
			  }	
			return c;
		}
	  

	  public String[] cadastraAluno(){
		 
		 for(c=0; c<=qtdAluno-1; c++) {
			 nome[c] = JOptionPane.showInputDialog("Digite o nome do aluno. ");
			 matricula += c; 
			 
			 }
			 System.out.println("matricula " +matricula + "nome " +nome[c]);
			  materia[c] +=  ("MATERIAS:" +materia[c]);
				
			  
	  return nome;
	  }
  
	  public String[] materia(){
		  
		  for(m =0; m< materia.length; m++){
			  
			  System.out.println("MATERIAS: "+materia[m]);
		  }
		 return materia;
	  }
	  
	  
	 
	  
	 public String relatorio (){
		
			
			for(c=1; c<=2; c++){
			for(m=1; m<=4; m++){
			
			JOptionPane.showMessageDialog
			      (null,"nome aluno\n"+nome[c]+ "matricula\n"+matricula +"media\n" +media[i] +"\nmaterias:\n" +materia[m]);
		}
	   }
		
	 
		
			
			return null;
	}	
			
		public String sair(){
			
			 JOptionPane.showMessageDialog(null,"Fim do programa");
			 return sair();
			 
		}
		}
[color=green][/color]
package avaliacao;

import aluno.*;
import javax.swing.*;

public class Avaliacao {
	public float nota[] =new float [4];
	public float total = 0;
	public float media[] = new float[4];
	int c = 0;
	int m = 0;
	int n = 0;
	Aluno al = new Aluno();
	 public float mediaAluno(){
		
	 JOptionPane.showMessageDialog(null,"Calculo da media de: "+al.materia[m] +"do "+al.nome);
		for ( c = 1; c<=al.qtdAluno; c++){
		   	for(m =0; m<=al.materia.length; m++){
		   		for(n=0;n<4;n++){
				 nota[n] = Float.parseFloat
			      (JOptionPane.showInputDialog("Digite a "+(n+1) +" de "+al.nome[c] +"nota de" +al.materia[m] ));
			      total += nota[n];
			      media[n] = total/4; 
				   System.out.println("total nota de"+al.materia[m] +total);
				   System.out.println("media de " +al.materia[m]+media[n]);
				   break;
		   		}	
			   
			}
			
		}
		return mediaAluno();
		
	 }		
}

4 Respostas

fiaux

Não sabe descrever por não saber explicar a classe ou por não saber usar o Javadoc?

V
rogeriosantos77

Mas a descição do que a clase faz é algo muito particular do projeto, quando vc diz que não sabe excplicar você se refere a forma de escrever a funcionalidade ?

Tenta ver artigos sobre o assunto como por exemplo

V

rogeriosantos77:
Mas a descição do que a clase faz é algo muito particular do projeto, quando vc diz que não sabe excplicar você se refere a forma de escrever a funcionalidade ?

Tenta ver artigos sobre o assunto como por exemplo

http://jmmwrite.wordpress.com/2008/09/15/criando-documentacao-java-de-sua-aplicacao/

Obrigada!

Criado 26 de novembro de 2008
Ultima resposta 26 de nov. de 2008
Respostas 4
Participantes 3