Skip to content

Commit

Permalink
City.java analysed and corrected
Browse files Browse the repository at this point in the history
  • Loading branch information
Hybeee committed May 6, 2024
1 parent a6ee7d7 commit d9b923a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
3 changes: 2 additions & 1 deletion doc/static_analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ Az elemzés során az előbb említett VSCode extension segítségével végign
### ./Game/Character.java
Az esetek túlnyomó részében a hiba itt a következő volt:
"Rename this method name to match the regular expression '^[a-z][a-zA-Z0-9]*$'."
A szabály leírása szerint a "naming convention"-ök csapatok együttműködését segítheti elő. A projekt során ezeket sajnos nem konzisztensen követtük mindenhol, így ez adott esetben javításra szorulna olyan szinte, hogy legalább az egyik naming convention-t követni kellene a projekt során. Mivel nem egy több csapat által kezelt projektről van szó, így a SonarLint-es warning által ajánlott convention lecserélhető lenne egy másikra - ha az konzisztensen lenne alkalmazva az egész projektben.
A szabály leírása szerint a "naming convention"-ök csapatok együttműködését segítheti elő. A projekt során ezeket sajnos nem konzisztensen követtük mindenhol, így ez adott esetben javításra szorulna olyan szinte, hogy legalább az egyik naming convention-t követni kellene a projekt során. Mivel nem egy több csapat által kezelt projektről van szó, így a SonarLint-es warning által ajánlott convention lecserélhető lenne egy másikra - ha az konzisztensen lenne alkalmazva az egész projektben. Ez a probléma a projekt egészében előfordul, így innentől kezdve ezt nem emeljük ki.

Ezzel szemben a problémák másik része már egy fontosabb hibára világítottak rá:
"Add a nested comment explaining why this method is empty, throw an UnsupportedOperationException or complete the implementation."
Alapjáraton ez problémás lenne. A sonarlint-es warning viszont megoldható azzal, ha egy placeholder kommentet a függvény hasába helyezünk - ezt eddig a függvény felé írtuk ezzel követve a kommentezési szokásokat.
### ./Game/City.java

### ./Game/Field.java
### ./Game/Game.java
### ./Game/Mechanic.java
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/hu/bomboclat/Game/City.java
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ public void Step(boolean rnd) {
* Visszaadja, hogy hány pontja van a szerelőknek vagyis a consumed értékét.
* @return A szerelők pontjai, a consumed tagváltozó értéke.
*/
@Override
public int getMechanicPoint(){
return consumed;
}
Expand All @@ -52,6 +53,7 @@ public int getMechanicPoint(){
* @param m a csövet felvenni kívánó szerelő játékos.
* @return A függvény a felvett cső objektumot adja vissza.
*/
@Override
public Pipe PickUpPipe(Mechanic m){
Pipe returnPipe = new Pipe();
PipeView pv = new PipeView(returnPipe);
Expand All @@ -71,9 +73,9 @@ public Pipe PickUpPipe(Mechanic m){
* A városból új pumpákat tudnak felvenni ezzel a függvénnyel.
* @return A függvény a felvett pumpa objektumot adja vissza.
*/
@Override
public Pump PickUpPump() {
Pump p = new Pump();
return p;
return new Pump();
}


Expand Down
Binary file modified target/classes/hu/bomboclat/Game/City.class
Binary file not shown.

0 comments on commit d9b923a

Please sign in to comment.