Følger denne koden standardkonvensjoner, ikke overflødig? Hvordan kan jeg gjøre det mer forståelig for andre mennesker?

Det er en øvelse fra Java introduksjonsbok:

Skriv en hangman-spill som tilfeldig genererer et ord og ber brukeren om å gjette en bokstav om gangen. Hver bokstav i ordet vises som en stjerne. Når brukeren gjetter riktig gjetning, vises den faktiske bokstaven. Når brukeren er ferdig med en ord, vis antall savner.

Mitt 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; } } 

Logg av sitt arbeid:

 (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)  

Kommentarer

  • Ville det være bra hvis jeg legger ved lenke på gratis bildebehandling med bilde av blokkeringsskjema som illustrerer logikken til programmet mitt, fordi det ' ikke er åpenbart hvordan det fungerer, eller det ' ikke er nødvendig?
  • Flytskjemaer og lignende vil øke th forståelsen av hva du ' gjør. At ' alltid er en god ting.
  • Jeg tror du ' har gjort en god jobb med å fjerne oppsigelser og skape metoder for å gjøre det mer kortfattet. Det er litt vanskelig å følge, skjønt. Kanskje mer beskrivende metodenavn vil hjelpe (den beste dokumentasjonen er lesbar kode!)
  • koden din er for komplisert, du trenger å forklare hva som skjer, da det er vanskelig for en student å lese og vite nøyaktig hva ' skjer. Takk.

Svar

Magiske tall: Det ville være bedre å flytte definisjonene dine til 0,1, 2,3 til et enum eller final felt slik at du kan referere til dem med et meningsfylt navn. For eksempel final int LETTER_NOT_IN_WORD = 0 eller enum HangmanGuess { LETTER_NOT_IN_WORD }

Redundans: Kjernelogikken mellom findEmptyLetters og inEmptyLetters er det samme, du leter etter en char i en char[] . Du kan reflektere slik:

/* 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)); } 

En ting å påpeke er også at i den nåværende implementeringen, findEmptyPosition vil returnere n der n er enteredLetters.length + 1 hvis det ikke er noen tomme posisjoner. Jeg er ikke sikker på om dette er ønsket funksjonalitet.

Svar

Første (liten) ting: det virker mer vanlig å bruk Random enn Math.random(). Se dette innlegget om beste praksis .

Kommentarene og byttet først i gjør {} mens () er veldig forvirrende for meg personlig. enterLetter() returnerer aldri true eller false, og til og med de fleste nye programmerere vet en gjør / mens den gjentar til betingelsen er oppfylt. Det ville være mer nyttig å beskrive hva 0-3 representerer (og hvis dette var produksjonskode eller mer kompleks, ville en Enum gjøre det betydelig mer forståelig).

Inne i enterLetter(), ville det være nyttig å flytte int emptyPosition = findEmptyPosition(enteredLetters); ring til else if der den brukes. Ikke bare forhindrer det å tildele minne til det er brukt, men det er også mer lesbart (og du kan fjerne emptyPosition -variabelen hvis du vil og ringe funksjonen inne i referansen , men det er semantisk).

Legg igjen en kommentar

Din e-postadresse vil ikke bli publisert. Obligatoriske felt er merket med *