newtonjose/engenharia-software-cs

Repositório com as implementações das aulas de Contrução de Software

Construção de Software (2019)

Disciplina do curso de Bacharelado em Engenharia de Software (UFG).

Algoritmos Implementados em JavaScript

Para ter acesso a documentação desse codigo:

• Prerequisitos: nodejs e npm

cd aula-01.js/js/
npm install
npm run doc

• Acessa a documentação usando o navegador:

<navegador> out/index.html

Minha de preferência

• Atividade documentada no tópico aula-09

engenharia-software-cs's Issues

Documentar métodos

Classe "ValidaParametros" contém métodos apenas parcialmente documentados.

Unir linhas 650 e 653 (js)

Não há motivo para declarar a variável em linha distante de onde é usada. Melhor é definir como const no interior do laço.

Acrescentar comentário do package (apenas "esqueleto" foi oferecido)

Evite h1 e outros elementos de estilo em Javadoc

Estes elementos podem "deformar" a apresentação esperada da documentação em html. Este é um dos itens a serem evitados. Observe, dentre outros cenários, o uso desta documentação em IDE, por exemplo, e não apenas via browser. Contudo, mesmo no browser você pode "quebrar" o estilo padrão.

Isto ocorre na linha 4 de Eratostenes.java

PMD apresenta não conformidades

Documentação de exceção após documentação do retorno de cada método

Métodos static

Classe Algoritmos (js) não deveria conter apenas métodos static. Alguns são, outros não. Entendo que TODOS podem ser adequadamente declarados como static.

Variáveis não documentadas (NumeroPrimo, por exemplo)

Checkstyle apresenta não conformidade

Classe Algoritmos.java sem utilidade

Remover a classe.

Alterar nome aula-01.js

Alterar nome do arquivo contendo implementação js para algo mais representativo do conteúdo da classe.

Testes em JavaScript estão incompletos

Apenas algumas funções foram contempladas por testes.

Software Design (reunir implementações na classe Algoritmos)

Agrupar funções na classe Algoritmos tem efeito parecido com o que já é clássico, por exemplo, basta observar a classe Math tanto em Java quanto em JavaScript. Minha sugestão é que reúna todos os métodos lá.

Neste caso, a remoção da classe Algoritmos (#15) é suspendida.

Esclarecimentos

Tendo em vista que:

• aprendizado é um processo que demanda dedicação e esforço consideráveis, além de constantes;
• falhas fazem parte do processo, de fato, no meu entendimento, são inevitáveis;
• falhas e dificuldades, embora inevitáveis, não podem impedir o progresso, o aprendizado, o contínuo aprimoramento; e que
• a turma dedica-se às atividades e há progresso claro (parabéns pelo esforço),

esclareço que:

• Em vez de duas atividades para serem concluídas até o dia primeiro de julho, teremos apenas uma única atividade, ao contrário do que foi apresentado no dia de ontem (11/06/2019).
• A data limite permanece primeiro de julho. Ou seja, a atividade a ser realizada conta com um período de três semanas inteiras para a sua realização, além de 7 horas em atividades supervisionadas.
• Nossa aula do dia 27 de junho será não presencial. Ou seja, você terá tempo adicional para concluir suas atividades sem o ônus de se deslocar até o laboratório. Em consequência, dia 25 de junho é o último dia para você esclarecer dúvidas com o professor. Ou seja, você tem duas semanas inteiras para esclarecer suas dúvidas sobre o que deve ser feito, sobre o critério de avaliação, sobre as suas issues, sobre os pull requests, sobre a qualidade do que você está produzindo, sobre os tópicos pertinentes à construção de software, enfim, sobre as suas dúvidas que só você pode apresentar.
• As datas acima são limites, tudo pode ser concluído antes.
• Os critérios de avaliação permanecem, assim como a forma de definição da nota. Se você está em dúvida, então entre em contato com o professor. De forma resumida, deve-se concluir o que foi pedido (não parcialmente), atender issues e pull requests, e com a qualidade definida por várias ferramentas para que a sua nota seja pelo menos 6,0. Há risco significativo aqui se não houver interação com o professor. Mais uma vez, esclareça suas dúvidas especificamente para o seu repositório (elemento de avaliação contínua da disciplina).
• A atividade a ser realizada, dado que antes eram duas, e agora apenas uma, predefinida pelo docente, é aquela da "Ordem de Serviço" (programa para identificar o dia da semana de uma data). Esta atividade foi identificada como pertencente ao tópico aula-10 (veja portal da disciplina).
• Você pode optar pela outra atividade, aquela atribuída ao tópico aula-09, o que cabe a você escolher, em vez do tópico aula-10, predefinido pelo docente. Caso queira optar pela atividade da aula-09, então deverá fazer o registro correspondente no arquivo README.md do seu repositório até as 19h59min do dia 13/06/2019, conforme ilustrado abaixo.

Minha preferência

Atividade documentada no tópico aula-10 (veja portal da disciplina).

Estas mudanças visam assegurar que nosso foco na “formação de profissionais aptos a contribuir efetivamente com a produção de softwares de qualidade seguindo princípios éticos e postura profissional” (objetivo do curso de Engenharia de Software), não seja prejudicado.

Há comentários FIXME no seu código aguardando pela sua atenção.

NumeroPrimo (linha 17)

Declare a classe como final e o construtor private, desta forma não é necessário gerar UnsupportedOperationException.

Este cenário se repete em várias classes (corrigir todas).

Eratostenes em vez de Erastostenes

Investigar possível bug linha 685 (js)

Conforme comentário, // 'a' sempre sera maior que 'b' pelo if anterior.
Trata-se de um erro no código?

Estilo (linha 727 em js)

Este estilo é mais legível que i += 1, por exemplo, amplamente empregado pelo seu código. Para sistemas de informação em geral, o estilo preferido é i = i + 1. Não é preciso fazer alteração no código já produzido, mas sugiro que mude o estilo nos próximos exercícios em benefício da legibilidade.