ATIVIDADE 3 - ESOFT - PROGRAMAÇÃO DE SISTEMAS I - 54/2023
A documentação de um programa é fundamental, independentemente da linguagem de programação utilizada. A documentação tem por objetivo apresentar esclarecimentos com relação ao código desenvolvido, isso de dá pela escrita de comentários diretamente no código-fonte. A documentação é essencialmente útil para a manutenção do sistema, que pode ser realizada por diferentes desenvolvedores. Dessa forma é fundamental criar uma documentação adequada e clara do sistema.
A documentação se dá pela inserção de comentários diretamente no código-fonte. Estes comentários podem ser classificados em dois tipos: o primeiro são os comentários utilizados para gerar a documentação externa ao código, no caso do Java com a ferramenta JavaDOC. O segundo são aqueles que estão disponíveis somente pela leitura direta no código fonte. Os dois tipos de comentários são ignorados pelo compilador durante o processo da geração do bytecode.
Veja a versão de uma calculadora em Java de forma estruturada. Isso porque os conceitos de Programação Orientada a Objetos serão vistos em disciplina posterior:
import java.util.Scanner;
public class CalculadoraEstruturada {
public static void main(String[] args) {
Scanner sc = new Scanner(System.in);
double operandoA, operandoB, resultado;
operandoA = operandoB = resultado = 0;
char operacao;
System.out.println("Escolha a operação: ");
System.out.println("Soma______________: + ");
System.out.println("Subtração_________: - ");
System.out.println("Multiplicação_____: * ");
System.out.println("Divisão___________: / ");
System.out.println("Potência__________: ^ ");
System.out.println("Valor de Pi_______: p ");
System.out.println("Valor de PHI______: f ");
System.out.println("Valor de e________: e ");
System.out.println("----------------------");
System.out.println("Sair______________: s \n");
System.out.println();
operacao = sc.next().charAt(0);
if (operacao == 's') {
} else if (operacao == 'p') {
resultado = getPi();
System.out.printf("pi= %.2f ", resultado);
} else if (operacao == 'f') {
resultado = getFi();
System.out.printf("phi= %.2f ", resultado);
} else if (operacao == 'e') {
resultado = getE();
System.out.printf("e= %.2f ", resultado);
} else if (operacao == '+' || operacao == '-'
|| operacao == '*' || operacao == '/' || operacao == '^') {
System.out.println("Operando A: ");
operandoA = sc.nextDouble();
System.out.println("Operando B: ");
operandoB = sc.nextDouble();
resultado = operacaoesBasicas(operandoA, operacao, operandoB);
System.out.printf("%.2f %c %.2f = %.2f", operandoA, operacao,
operandoB, resultado);
}
}
public static double operacaoesBasicas(double x, char operador, double y) {
double resultado = 0.0;
switch (operador) {
case '+':
resultado = x + y;
break;
case '-':
resultado = x - y;
break;
case '*':
resultado = x * y;
break;
case '/':
resultado = x / y;
break;
case '^':
resultado = Math.pow(x, y);
}
return resultado;
}
public static double getPi() {
return Math.PI;
}
public static double getE() {
return Math.E;
}
public static double getFi() {
return 1.61803398874989484820;
}
}
A partir do código-fonte apresentado, efetue as seguintes atividades:
- Efetue a criação de um arquivo java com o código apresentado.
- Efetue a documentação do código com o uso de comentários JavaDoc, incluindo os seguintes itens:
- Descrição do programa.
- Definir um hiperlink para a documentação do JavaDOC com o endereço https://docs.oracle.com/javase/8/docs... (tag @see).
- Especificação da autoria do programa (tag @Autor).
- Especificação da versão (tag @Version).
- Descrição de cada um dos métodos (funções), os parêmtros de entrada (tag @param) e o retorno (tag @return).
- Aperfeiçoe a documentação se achar necessário, com as respectivas tags.
- Efetue a criação da documentação JavaDOC para o programa da calculadora. O JavaDOC, similar ao javac, pode ser executado pela IDE utilizada, ou diretamente pela linha
