辅导COMP2013编程、Software程序讲解、辅导Java设计程序
- 首页 >> Java编程 COMP2013-Developing Maintainable Software Coursework Preview
For the Academic Year 2020/2021
This is a preview of the forthcoming coursework. The software base will stay the same and the basic
software requirements will stay the same. Some of the submission details will be modified and the
way the document is organized will also be modified.
This coursework is about maintaining and extending a re-implementation of a classic retro game called
Sokoban. The new implementation has never been completed, but at least it runs, once it is set up
properly. More information about the original Sokoban game and its history is available at Wikipedia
(https://en.wikipedia.org/wiki/Sokoban). In addition, you will find lots of opportunities on the internet
to play the original game online.
To start, please download "COMP2013-BestSokobanEverV6_src.zip" from Moodle. Set up a project
(e.g. JavaFX or Maven) in your preferred IDE (either Eclipse or IntelliJ) and embed the files that you
just downloaded. Note that the zip file you downloaded from Moodle only provides source code and
resources but no project files, as it is good practice to ignore IDE-specific generated files for source
control. Add a .gitignore file to your project, ensuring that you follow this good practice as well. Set
up a remote git repository at the school's GitLab server (https://projects.cs.nott.ac.uk). Your remote
repository need to be named COMP2013_CW_CompSciUserName (e.g. in my case it would be
COMP2013_CW_pszps) and needs to be set to PRIVATE. Then follow the setup instructions provided
in GitLab to "Push an existing folder" (i.e. do an initial push to upload files from your local to your
remote repository). Now you are ready for coding with version control.
The marks will be split as follows:
• 15% for git use (e.g. push, branch, merge, providing .gitignore)
• 30% for refactoring
• 30% for additions
• 15% for documentation (Readme.md + Javadocs + class diagram)
• 10% for a video, explaining your refactoring activities and additions
You should roughly spend 70 HOURS on this coursework
IMPORTANT: Make sure you understand what you are writing in your code and Javadocs. We reserve
the right to briefly interview you if we think that you do not understand it.
What to produce:
• A Readme.md file (max. 500 words), documenting the work you conducted (highlighting the
key changes you made for maintenance and extension, where you made them, and why you
made them). WARNING: If you don't mention it here, don't blame us later, if we miss it!
• High level class diagram that shows the structure of the final version of your game (considering
only classes (excluding fields and methods, unless they are relevant for understanding design
principles/patterns), interfaces, relationships, and multiplicity). If you use software to reverse
engineer your class diagram, make sure the delivered diagram is correct and follows the above
requirements.
• The source code documentation (Javadocs) should be delivered in form of a Javadoc folder
inside your project folder. Besides reading your README.md file we will look at the Javadocs
to find out how you maintained and extended the game. If it is not obvious from there we
might miss it. Also we have only a limited amount of time to look at each coursework
submitted. So, please make sure to provide informative but concise Javadocs.
2
• Finally, you have to make a 3 minute video (very briefly) showing your software running and
then (for the main part) explaining your refactoring activities and additions. You should also
highlight two achievements you are most proud of.
Important:
• This coursework is about maintaining and extending existing code. So, for the maintenance
part YOU HAVE TO USE THE CODE WE PROVIDE (COMP2013-BestSokobanEverV6_src.zip) as a
basis, and not write your own Sokoban game from scratch, or use source code from other
campuses.
To pass the assessment (40%):
• Set up a PRIVATE git repository on the school's GitLab server (https://projects.cs.nott.ac.uk/)
and use it actively for version control activities
• Do some basic maintenance of the delivered code base (this should include things like adding
meaningful Readme.md and Javadocs, organising files in a meaningful way into packages,
breaking up large classes in a meaningful way to support the idea of single responsibility,
improving encapsulation, etc.)
• Extend the delivered code base by adding:
o A START screen with some setup options to choose a wall colour (currently black) for
the game field (allowing a choice of at least 8 colours) and a button that allows going
to the GAME screen.
o A HIGH SCORE pop-up, appearing at the end of each round, showing the scores from
each round, highest at the top.
For higher marks: In addition to the previous, do some of the following...
• Refactor the code by adding some design patterns to enhance maintainability
• Organise the code to adhere to the MVC pattern
• Create a permanent high score list (using a file to store scores)
• Add interesting levels to the game (either based on your own ideas or the original game)
• Add meaningful JUnit tests
• Use build files (Maven or Gradle)
• Come up with your own ground breaking idea ... surprise us :)
You have to use Java 10 or higher and JavaFX 10 or higher for the implementation. The project files
you are submitting need to be either compatible with Eclipse or IntelliJ.
Deliverables: Three separate files, uploaded to Moodle:
• A zip file containing your ENTIRE LOCAL PROJECT FOLDER (including a copy of your
README.md and Javadocs files). It needs to be possible to IMPORT (or OPEN) and RUN your
project in either Eclipse or IntelliJ. To avoid disappointment later, test your final version on a
different computer. This should help to uncover hardcoded path dependencies, which was a
major issue in previous years. Name your zip file: "Surname_FirstName_IDE_JavaVersion.zip",
where IDE represents the name of the IDE you used and JavaVersion the Java version you
used. Here is an example: "Siebers_Peer-Olaf_IntelliJ_15.zip".
• Your final class diagram as pdf. Please name your pdf as follows: "Surname_FirstName.pdf".
For me, this would be "Siebers_Peer-Olaf.pdf"
• A 3 minute video, as described above, in a commonly used video format. Please name your
video as follows: "Surname_FirstName.EXT", where EXT represents the extension related to
your video format (either mp4 or avi). For me, this would be: "Siebers_Peer-Olaf.mp4".
3
Note: You are gently reminded that we are at liberty to use plagiarism detection software on your
submission. Plagiarism will not be tolerated, and academic offences will be dealt with in accordance
with university policy and as detailed in the student handbook. This means you may informally discuss
the coursework with other students but your submission must be your own work. Please also note
that it is not permitted for you to copy and paste text from another source without correct referencing.
If you are unclear about this process, please discuss with the module convenors during one of our lab
sessions or at the end of a teaching session.
Assessment Details:
• This coursework is contributing 75% to your overall grade and will be marked out of 100.
• To give you an idea about what we are looking for when we do the marking, we have attached
our draft marking scheme as an appendix. Please note that this is only a guide for us and does
not guarantee you marks when you have done certain things! There is always an aspect of
quality that needs to be considered as well. We also reserve the right to revise the marking
scheme (within limits), if we see the need for this during the marking process.
Penalties (besides late submission penalty, which follows University of Nottingham standards):
• Using wrong document formats (word instead of pdf) or video formats (swf instead of mp4 or
avi) will lead to a penalty of -2 each
• Failing to comply with any naming conventions requested in this task sheet will lead to a
penalty of -1 each.
Questions:
• Dr Siebers and Dr Laramee will of course be happy to answer questions and give high level
interim formative feedback on your assignment. If you get stuck, please get in touch!
However, we might refuse to answer very detailed technical questions, or very general
questions like "What do you think about my project so far?".
• Please be aware that there will also be a lot of useful tips and answered questions on the
COMP2013 Moodle page, in particular in the Announcement section.
Finally, please note that we may make some small modification to the coursework specs. We will
announce these on Moodle and keep a change log there as well.
Good luck, have fun, code well :).
4
Appendix: Draft Marking Scheme
For the Academic Year 2020/2021
This is a preview of the forthcoming coursework. The software base will stay the same and the basic
software requirements will stay the same. Some of the submission details will be modified and the
way the document is organized will also be modified.
This coursework is about maintaining and extending a re-implementation of a classic retro game called
Sokoban. The new implementation has never been completed, but at least it runs, once it is set up
properly. More information about the original Sokoban game and its history is available at Wikipedia
(https://en.wikipedia.org/wiki/Sokoban). In addition, you will find lots of opportunities on the internet
to play the original game online.
To start, please download "COMP2013-BestSokobanEverV6_src.zip" from Moodle. Set up a project
(e.g. JavaFX or Maven) in your preferred IDE (either Eclipse or IntelliJ) and embed the files that you
just downloaded. Note that the zip file you downloaded from Moodle only provides source code and
resources but no project files, as it is good practice to ignore IDE-specific generated files for source
control. Add a .gitignore file to your project, ensuring that you follow this good practice as well. Set
up a remote git repository at the school's GitLab server (https://projects.cs.nott.ac.uk). Your remote
repository need to be named COMP2013_CW_CompSciUserName (e.g. in my case it would be
COMP2013_CW_pszps) and needs to be set to PRIVATE. Then follow the setup instructions provided
in GitLab to "Push an existing folder" (i.e. do an initial push to upload files from your local to your
remote repository). Now you are ready for coding with version control.
The marks will be split as follows:
• 15% for git use (e.g. push, branch, merge, providing .gitignore)
• 30% for refactoring
• 30% for additions
• 15% for documentation (Readme.md + Javadocs + class diagram)
• 10% for a video, explaining your refactoring activities and additions
You should roughly spend 70 HOURS on this coursework
IMPORTANT: Make sure you understand what you are writing in your code and Javadocs. We reserve
the right to briefly interview you if we think that you do not understand it.
What to produce:
• A Readme.md file (max. 500 words), documenting the work you conducted (highlighting the
key changes you made for maintenance and extension, where you made them, and why you
made them). WARNING: If you don't mention it here, don't blame us later, if we miss it!
• High level class diagram that shows the structure of the final version of your game (considering
only classes (excluding fields and methods, unless they are relevant for understanding design
principles/patterns), interfaces, relationships, and multiplicity). If you use software to reverse
engineer your class diagram, make sure the delivered diagram is correct and follows the above
requirements.
• The source code documentation (Javadocs) should be delivered in form of a Javadoc folder
inside your project folder. Besides reading your README.md file we will look at the Javadocs
to find out how you maintained and extended the game. If it is not obvious from there we
might miss it. Also we have only a limited amount of time to look at each coursework
submitted. So, please make sure to provide informative but concise Javadocs.
2
• Finally, you have to make a 3 minute video (very briefly) showing your software running and
then (for the main part) explaining your refactoring activities and additions. You should also
highlight two achievements you are most proud of.
Important:
• This coursework is about maintaining and extending existing code. So, for the maintenance
part YOU HAVE TO USE THE CODE WE PROVIDE (COMP2013-BestSokobanEverV6_src.zip) as a
basis, and not write your own Sokoban game from scratch, or use source code from other
campuses.
To pass the assessment (40%):
• Set up a PRIVATE git repository on the school's GitLab server (https://projects.cs.nott.ac.uk/)
and use it actively for version control activities
• Do some basic maintenance of the delivered code base (this should include things like adding
meaningful Readme.md and Javadocs, organising files in a meaningful way into packages,
breaking up large classes in a meaningful way to support the idea of single responsibility,
improving encapsulation, etc.)
• Extend the delivered code base by adding:
o A START screen with some setup options to choose a wall colour (currently black) for
the game field (allowing a choice of at least 8 colours) and a button that allows going
to the GAME screen.
o A HIGH SCORE pop-up, appearing at the end of each round, showing the scores from
each round, highest at the top.
For higher marks: In addition to the previous, do some of the following...
• Refactor the code by adding some design patterns to enhance maintainability
• Organise the code to adhere to the MVC pattern
• Create a permanent high score list (using a file to store scores)
• Add interesting levels to the game (either based on your own ideas or the original game)
• Add meaningful JUnit tests
• Use build files (Maven or Gradle)
• Come up with your own ground breaking idea ... surprise us :)
You have to use Java 10 or higher and JavaFX 10 or higher for the implementation. The project files
you are submitting need to be either compatible with Eclipse or IntelliJ.
Deliverables: Three separate files, uploaded to Moodle:
• A zip file containing your ENTIRE LOCAL PROJECT FOLDER (including a copy of your
README.md and Javadocs files). It needs to be possible to IMPORT (or OPEN) and RUN your
project in either Eclipse or IntelliJ. To avoid disappointment later, test your final version on a
different computer. This should help to uncover hardcoded path dependencies, which was a
major issue in previous years. Name your zip file: "Surname_FirstName_IDE_JavaVersion.zip",
where IDE represents the name of the IDE you used and JavaVersion the Java version you
used. Here is an example: "Siebers_Peer-Olaf_IntelliJ_15.zip".
• Your final class diagram as pdf. Please name your pdf as follows: "Surname_FirstName.pdf".
For me, this would be "Siebers_Peer-Olaf.pdf"
• A 3 minute video, as described above, in a commonly used video format. Please name your
video as follows: "Surname_FirstName.EXT", where EXT represents the extension related to
your video format (either mp4 or avi). For me, this would be: "Siebers_Peer-Olaf.mp4".
3
Note: You are gently reminded that we are at liberty to use plagiarism detection software on your
submission. Plagiarism will not be tolerated, and academic offences will be dealt with in accordance
with university policy and as detailed in the student handbook. This means you may informally discuss
the coursework with other students but your submission must be your own work. Please also note
that it is not permitted for you to copy and paste text from another source without correct referencing.
If you are unclear about this process, please discuss with the module convenors during one of our lab
sessions or at the end of a teaching session.
Assessment Details:
• This coursework is contributing 75% to your overall grade and will be marked out of 100.
• To give you an idea about what we are looking for when we do the marking, we have attached
our draft marking scheme as an appendix. Please note that this is only a guide for us and does
not guarantee you marks when you have done certain things! There is always an aspect of
quality that needs to be considered as well. We also reserve the right to revise the marking
scheme (within limits), if we see the need for this during the marking process.
Penalties (besides late submission penalty, which follows University of Nottingham standards):
• Using wrong document formats (word instead of pdf) or video formats (swf instead of mp4 or
avi) will lead to a penalty of -2 each
• Failing to comply with any naming conventions requested in this task sheet will lead to a
penalty of -1 each.
Questions:
• Dr Siebers and Dr Laramee will of course be happy to answer questions and give high level
interim formative feedback on your assignment. If you get stuck, please get in touch!
However, we might refuse to answer very detailed technical questions, or very general
questions like "What do you think about my project so far?".
• Please be aware that there will also be a lot of useful tips and answered questions on the
COMP2013 Moodle page, in particular in the Announcement section.
Finally, please note that we may make some small modification to the coursework specs. We will
announce these on Moodle and keep a change log there as well.
Good luck, have fun, code well :).
4
Appendix: Draft Marking Scheme