Dodržuje tento kód standardní konvence, není nadbytečný? Jak mohu zajistit, aby to bylo pro ostatní lidi srozumitelnější?
Je to cvičení z úvodní knihy Java:
Napsat hra s katem, která náhodně vygeneruje slovo a vyzve uživatele k uhádnutí jednoho písmena najednou. Každé písmeno ve slově se zobrazí jako hvězdička. Když uživatel správně uhodne, zobrazí se skutečné písmeno. Když uživatel dokončí slovo, zobrazit počet zmeškaných.
Můj program:
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 jeho práce:
(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)
Komentáře
- Bylo by dobré, kdybych připojil odkaz na free-image hosting s obrázkem blokového schématu ilustrujícím logika mého programu, protože ' není zřejmé, jak to funguje, nebo to ' není nutné?
- Vývojové diagramy a podobně by zvýšily th Srozumitelnost toho, co ' děláte. To ' je vždy dobrá věc.
- Myslím, že jste ' odvedli dobrou práci při odstraňování nadbytečnosti a vytváření metody, aby to bylo stručnější. Je to trochu těžké sledovat. Možná by pomohly popisnější názvy metod (nejlepší dokumentací je čitelný kód!)
- váš kód je příliš komplikovaný, musíte vysvětlit, o co jde, protože je pro studenta obtížné číst a přesně vědět ' se děje. Děkuji.
Odpověď
Magická čísla: Bylo by lepší přesunout definice za 0,1, 2,3 do enum
nebo final
polí, abyste na ně mohli uvést smysluplný název. Například final int LETTER_NOT_IN_WORD = 0
nebo enum HangmanGuess { LETTER_NOT_IN_WORD }
Redundance: Základní logika mezi findEmptyLetters
a inEmptyLetters
jsou stejné, hledáte char
v char[]
. Dalo by se to refaktorovat takto:
/* 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)); }
Je třeba také upozornit na to, že v současné implementaci findEmptyPosition
vrátí n
kde n
je enteredLetters.length + 1
, pokud nejsou prázdné pozice. Nejsem si jistý, jestli se jedná o požadovanou funkčnost.
Odpověď
První (malá) věc: zdá se běžnější použijte Random
než Math.random()
. Viz tento doporučený postup .
Komentáře a přepnutí první věci uvnitř dělat {} while () je pro mě osobně velmi matoucí. enterLetter()
nikdy nevrací true
nebo false
a dokonce i většina nových programátorů zná do / while iterace, dokud není podmínka splněna. Bylo by užitečnější popsat, co představují 0-3 (a jestli toto pokud byl produkční kód nebo složitější, Enum by to podstatně srozumitelnější).
Uvnitř enterLetter()
by bylo užitečné přesunout int emptyPosition = findEmptyPosition(enteredLetters);
volání else if
volání, kde se používá. Nejen, že brání přidělení paměti, dokud se nepoužije, ale je také čitelnější (a proměnnou emptyPosition
můžete odstranit, pokud chcete, a zavolat funkci uvnitř odkazu , ale to je sémantické).