COMP2013-Developing Maintainable

COMP2013-Developing Maintainable
Software Coursework
Last Update: 12 Nov 2020 (Technical Help FAQ added at bottom)
Number of Credits: 75% of a 20 credit module. This coursework is contributing 75% to your
overall grade and will be marked out of 100.
Recommendations: We recommend dedicating approximately 40-70 total hours (6.7-11.6
hours / week) on this coursework. We expect 30-40 hours of work for those who are aiming for
a pass (40+%) and around 60+ hours for those that are aiming for a first (70+%). Also, the
exact number of hours depends on your current skill level. Skill level varies quite a bit in a class
with over 200 students. In order to help you, we have no required lectures in the last week of
term and some of the lab sessions are dedicated to your coursework.
Deadline: The deadline will be most likely the second week in December. The exact deadline
will be posted on Moodle
Assessment: 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 file + source code documentation)
· 10% for the demonstration video, explaining your refactoring activities and additions
Questions: For questions related to coursework we have a new channel in Teams called
"Coursework Questions". Please post your coursework related questions there and we will try
to answer them as quickly as possible. Please read the questions that have been already
asked before you post yours, to avoid duplication. Also bring your coursework questions to the
lab.
Summary: 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 on Wikipedia (https://en.wikipedia.org/wiki/Sokoban). In addition, you will
find many opportunities on the internet to play the original game online.
Requirement Specification
Basic Requirements (to pass the assessment with 40%):
1. 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.
2. Do some basic maintenance of the delivered code base (this should include things like
adding meaningful Readme 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.)
3. Extend the delivered code base by adding:
3.1. A START screen with some setup options to choose a wall color (currently black)
for the game field (allowing a choice of at least 8 colours) and a button that allows going
to the GAME screen.
3.2. A HIGH SCORE pop-up, appearing at the end of each round, showing the scores
from each round, highest at the top.
Additional Requirements: For higher marks: In addition to the previous, do some of the
following...
A1. Refactor the code by adding some design patterns to enhance maintainability
A2. Organise the code to adhere to the MVC pattern
A3. Create a permanent high score list (using a file to store scores)
A4. Add interesting levels to the game (either based on your own ideas or the original game)
A5. Add meaningful JUnit tests
A6. Use build files (Maven or Gradle)
A7. Come up with your own ground breaking idea ... surprise us :)
Java Version + IDE: 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,
IntelliJ, or Netbeans.
JavaFX: Please be aware that you have to know JavaFX in order to understand the source
code. We will look at JavaFX for two full weeks, starting in the week commencing the 9
November. If you want to install JavaFX and try it out beforehand, please have a look at
https://openjfx.io/. Here you will find information about how to install JavaFX and how to use it
from the command line or from within the IDE of your choice. JavaFX also offers a mailing list
where you can ask questions.代做COMP2013编程、代写Software程序课程
Version Control: 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 is named
COMP2013_UserName (e.g. COMP2013_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.
Object-Oriented Implementation: The implementation needs to adhere to some rules. We
require these rules because we want a good product to be delivered. When we look under the
hood, he does not want to see a pile of scrap metal, but rather a finely tuned, carefully crafted
machine. You are required to follow Bob’s Concise Coding Conventions. See moodle for a
copy of this document. And yes, points will be deducted for magic numbers and other rules that
are not followed.
Assignment Submission and Organization
This section describes which files need to be submitted for assignment and how they should be
organized. Remember, there are a LARGE number of students in the class, thus the
organization of your submission is very important. You are required to create a root folder
called COMP2013surnameFirstname, where “surname” is replaced with your surname,
likewise for “firstname”, The COMP2013surnameFirstname folder contains (and organizes)
digital copies of all of the files that compose the assignment.
Assignment Report: 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.
Your report contains the following information:
1. Your name and student number,
2. How to compile the code to produce the application,
3. Where your Javadoc documentation is stored (the path to the directory)
4. A list of features that are implemented and are working properly,
5. A list of features that are implemented and are not working properly,
6. A list of features, if any, that are not implemented with an explanation of why they were not
implemented,
7. A list of new Java classes that you introduced for the assignment,
8. A list of Java classes that you modified from the given code base,
The report also also informs the reader if any unexpected problems arose during the course of
the assignment. Feel free to add any information which you feel is relevant.
Design Diagram: A file called Design.pdf contains a 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.
Project Implementation Files and Folders: A zip file containing your ENTIRE LOCAL
PROJECT FOLDER. 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: "SurnameFirstName_IDE_JavaVersion.zip", where IDE
represents the name of the IDE you used and JavaVersion the Java version you used. Here is
an example: "SiebersPeer_IntelliJ_15.zip".
Place the .zip file in a folder called project that resides in the COMP2013surnameFirstname
folder described above.
Source Code Documentation: A copy of your Javadoc documentation submitted online is
required. Javadoc produces a series of linked HTML web pages in order to facilitate the
browsing of project implementations. The HTML web pages produced by Javadoc are placed in
a folder called javadoc that resides in the COMP2013surnameFirstname folder described
above. Recall that the Java output contains: (1) a brief description of each class, (2) a
description of each method including input and return parameters, and (3) the original source
code. The new Java classes you write use the following author tag convention:
@author Firstname Surname.
All modified Java classes from the previous code base use the following author tag convention:
@author Firstname Surname-modified.
In addition to reading your README 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.
Demo via Screen Capture: Use screen capturing software to demonstrate the features of your
application. The video is up to 3 minutes in length. The movie file is saved in MPEG or MP4
format. Also, you can use MPEG2 and MPEG4 compression formats. Your animated screen
capture demo is called surnameFirstnameDemo.mp4 (or .mp2 or .mpg) and resides in the
COMP2013surnameFirstName folder described above. Note that the demo movie will be the
primary way in which we assess whether or not your functionality is working. The demo movie
shows your software running and then (for the main part) explains your refactoring activities and
additions. You also highlight two achievements you are most proud of.
Folder and File Organization
Thus, when completing the submission of the assignment, you have a directory structure in your
COMP2013surnameFirstname folder that looks like this:
README.md
Design.pdf
surnameFirstnameDemo.mp4
project/surnameFirstname_IDE_JavaVersion.zip
Assessment
To give you an idea about what we are looking for when we do the marking, we provide a 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 incorrect document formats (word instead of pdf) or video formats (swf instead of
mp4) 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 -2 each.
Important Hints Notes
Source code: 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.
Interview: 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.
Changes: 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.
Feedback: 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?".
Tips: 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 and in the labs.
Plagiarism: 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.
Good luck, have fun, code well :).
References
(Laramee, 2007) R.S. Laramee. Bob’s Concise Introduction to Doxygen. Technical report,
The Visual and Interactive Computing Group, Computer Science Department, Swansea
University, Wales, UK, 2007. (available online).
(Laramee, 2010) R.S. Laramee. Bob’s Concise Coding Conventions (C3). Advances in
Computer Science and Engineering (ACSE), 4(1):23–26, 2010. (available online).
Appendix: Draft Marking Scheme
Technical FAQs and Tips on the Coursework
How to install the coursework project on your local machine - some tips
We have made two short videos, explaining how it's done in IntelliJ and Eclipse. You can find the videos
in the Moodle "Assessment" section.
Coursework - how to approach it ...
Peer: I have been ask by a student, how I would approach the coursework. Here is my ad-hoc answer:
The way I would approach this is to set up the local and remote git repository. Then I would inspect the
code, perhaps using a debugger. While inspecting the code I would add any kind of understanding I
gained as comments or Javadocs to the code. I would perhaps consider using a reverse engineering tool
for creating a class diagram, but I would not want to rely on it, and would also create one manually,
while inspecting the code. Once I know the code a bit better I would do some basic maintenance, e.g.
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, and sorting out other things that are
easy to do. Then I would perhaps create a new class diagram which shows my planned alterations and
extensions. Then I would go for the more difficult maintenance and extension tasks. Then I would add
some surprises :).
Bob: In addition to what Peer stated, I would also start applying the debugging guidelines we went over in
the debugging lab. Start inserting test and m_trace flags into the classes to understand the flow of control
starting with the main method. Also, I would definitely create some auto-generated diagrams of of the
code using built-in diagram generators in IntelliJ or some other IDE.
Some set-up help for Mac users, having issues with seeing the game window
If you are a Mac user and you have issues with seeing the game window, go to "Run as > Run
Configurations..." and untick the option "Use the XstartOnFirstThread argument when launching with
SWT". That should do the trick ;-). See attache screenshots for details.
Error Message: Module xxx not found
For this specific problem (Module xxx not found), change the first line in module-info.java to Module
xxx, since the file students download and project have a different name.
Error Setting Up Project with JavaFX
I have downloaded the javaFX jdk and tried to add it to my Intellij SDKs but I keep getting this error.
“The selected directory is not a valid home for JDK”.
Check out this article:
https://stackoverflow.com/questions/21713414/intellij-idea-the-selected-directory-is-not-a-vali
d-home-for-jdk

如有需要，请加QQ：99515681 或邮箱：99515681@qq.com 微信：codehelp

标签：code,would,Maintainable,coursework,Developing,COMP2013,will,file,your
来源： https://www.cnblogs.com/welpython4/p/14090938.html