Este código segue as convenções padrão, não é redundante? Como posso torná-lo mais compreensível para outras pessoas?
É um exercício do livro introdutório ao Java:
Escreva um jogo da forca que gera aleatoriamente uma palavra e solicita que o usuário adivinhe uma letra por vez. Cada letra da palavra é exibida como um asterisco. Quando o usuário faz uma estimativa correta, a letra real é exibida. Quando o usuário termina um palavra, exibe o número de erros.
Meu programa:
import java.util.Arrays; import java.util.Scanner; public class Hangman{ public static void main(String[] args) { String[] words = {"writer", "that", "program"}; // Pick random index of words array int randomWordNumber = (int) (Math.random() * words.length); // Create an array to store already entered letters char[] enteredLetters = new char[words[randomWordNumber].length()]; int triesCount = 0; boolean wordIsGuessed = false; do { // infinitely iterate through cycle as long as enterLetter returns true // if enterLetter returns false that means user guessed all the letters // in the word e. g. no asterisks were printed by printWord switch (enterLetter(words[randomWordNumber], enteredLetters)) { case 0: triesCount++; break; case 1: triesCount++; break; case 2: break; case 3: wordIsGuessed = true; break; } } while (! wordIsGuessed); System.out.println("\nThe word is " + words[randomWordNumber] + " You missed " + (triesCount -findEmptyPosition(enteredLetters)) + " time(s)"); } /* Hint user to enter a guess letter, returns 0 if letter entered is not in the word (counts as try), returns 1 if letter were entered 1st time (counts as try), returns 2 if already guessed letter was REentered, returns 3 if all letters were guessed */ public static int enterLetter(String word, char[] enteredLetters) { System.out.print("(Guess) Enter a letter in word "); // If-clause is true if no asterisks were printed so // word is successfully guessed if (! printWord(word, enteredLetters)) return 3; System.out.print(" > "); Scanner input = new Scanner(System.in); int emptyPosition = findEmptyPosition(enteredLetters); char userInput = input.nextLine().charAt(0); if (inEnteredLetters(userInput, enteredLetters)) { System.out.println(userInput + " is already in the word"); return 2; } else if (word.contains(String.valueOf(userInput))) { enteredLetters[emptyPosition] = userInput; return 1; } else { System.out.println(userInput + " is not in the word"); return 0; } } /* Print word with asterisks for hidden letters, returns true if asterisks were printed, otherwise return false */ public static boolean printWord(String word, char[] enteredLetters) { // Iterate through all letters in word boolean asteriskPrinted = false; for (int i = 0; i < word.length(); i++) { char letter = word.charAt(i); // Check if letter already have been entered bu user before if (inEnteredLetters(letter, enteredLetters)) System.out.print(letter); // If yes - print it else { System.out.print("*"); asteriskPrinted = true; } } return asteriskPrinted; } /* Check if letter is in enteredLetters array */ public static boolean inEnteredLetters(char letter, char[] enteredLetters) { return new String(enteredLetters).contains(String.valueOf(letter)); } /* Find first empty position in array of entered letters (one with code \u0000) */ public static int findEmptyPosition(char[] enteredLetters) { int i = 0; while (enteredLetters[i] != "\u0000") i++; return i; } }
Log de seu trabalho:
(Guess) Enter a letter in word **** > a (Guess) Enter a letter in word **a* > t (Guess) Enter a letter in word t*at > q q is not in the word (Guess) Enter a letter in word t*at > t t is already in the word (Guess) Enter a letter in word t*at > b b is not in the word (Guess) Enter a letter in word t*at > h (Guess) Enter a letter in word that The word is that You missed 2 time(s)
Comentários
- Seria bom se eu anexasse um link para hospedagem de imagem gratuita com imagem de esquema de bloco ilustrando lógica do meu programa, porque ' não é óbvio como funciona ou ' não é necessário?
- Fluxogramas e similares aumentariam o e compreensão do que você ' está fazendo. Isso ' é sempre uma coisa boa.
- Acho que você ' fez um bom trabalho removendo redundâncias e criando métodos para torná-lo mais conciso. No entanto, é um pouco difícil de entender. Talvez nomes de métodos mais descritivos ajudem (a melhor documentação é um código legível!)
- seu código é muito complicado, você precisa explicar o que está acontecendo, pois é difícil para um aluno ler e saber exatamente o que ' está acontecendo. Obrigado.
Resposta
Números mágicos: seria melhor mover suas definições para 0,1, 2,3 em um campo enum
ou final
para que você possa referenciá-los com um nome significativo. Por exemplo final int LETTER_NOT_IN_WORD = 0
ou enum HangmanGuess { LETTER_NOT_IN_WORD }
Redundância: a lógica central entre findEmptyLetters
e inEmptyLetters
é o mesmo, você está procurando por um char
em um char[]
. Você poderia refatorar assim:
/* Check if letter is in enteredLetters array */ public static boolean inEnteredLetters(char letter, char[] enteredLetters) { return indexOf(letter, enteredLetters) >= 0; } /* Find first empty position in array of entered letters (one with code \u0000) */ public static int findEmptyPosition(char[] enteredLetters) { return indexOf("\u0000", enteredLetters) } /* Determine the index in {@code vals} where {@code ch} exists. Returns -1 if {@code ch} is not in {@code vals}. */ public static int indexOf(char ch, char[] vals) { return Arrays.asList(vals).indexOf(Character.valueOf(ch)); }
Uma coisa a apontar também é que, na implementação atual, findEmptyPosition
retornará n
onde n
é o enteredLetters.length + 1
se não houver posições vazias. Não tenho certeza se esta é a funcionalidade desejada.
Resposta
Primeira (pequena) coisa: parece mais comum use Random
do que Math.random()
. Veja esta postagem de práticas recomendadas .
Os comentários e a primeira mudança dentro de do {} while () são muito confusos para mim pessoalmente. enterLetter()
nunca retorna true
ou false
, e até mesmo a maioria dos novos programadores sabem um do / while itera até que a condição seja atendida. Seria mais útil descrever o que 0-3 representa (e se isso se o código de produção fosse mais complexo, um Enum o tornaria consideravelmente mais compreensível).
Dentro de enterLetter()
, seria útil mover o int emptyPosition = findEmptyPosition(enteredLetters);
chamada para o else if
onde é usado. Não apenas evita a alocação de memória até que seja usada, mas também é mais legível (e você poderia remover a variável emptyPosition
se quisesse e chamar a função dentro da referência , mas isso é semântico).