写作COMP2013编程、辅导Software程序、Java语言程序

” 写作COMP2013编程、辅导Software程序、Java语言程序COMP2013-Developing MaintainableSoftware CourseworkLast 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 youroverall grade and will be marked out of 100.Recommendations: We recommend dedicating approximately 40-70 total hours (6.7-11.6hours / week) on this coursework. We expect 30-40 hours of work for those who are aiming fora pass (40+%) and around 60+ hours for those that are aiming for a first (70+%). Also, theexact number of hours depends on your current skill level. Skill level varies quite a bit in a classwith over 200 Students. In order to help you, we have no required lectures in the last week ofterm 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 deadlinewill be posted on MoodleAssessment: 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 additionsQuestions: For questions related to coursework we have a new channel in Teams calledCoursework Questions. Please post your coursework related questions there and we will tryto answer them as quickly as possible. Please read the questions that have been alreadyasked before you post yours, to avoid duplication. Also bring your coursework questions to thelab.Summary: This coursework is about maintaining and extending a re-implementation of aclassic retro game called Sokoban. The new implementation has never been completed, but atleast it runs, once it is set up properly. More information about the original Sokoban game andits history is available on Wikipedia ( httpss://en.wikipedia.org/wiki/Sokoban). In addition, you willfind many opportunities on the internet to play the original game online.Requirement SpecificationBasic Requirements (to pass the assessment with 40%):1. Set up a PRIVATE git repository on the schools GitLab server( httpss://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 likeadding meaningful Readme and Javadocs, organising files in a meaningful way intopackages, breaking up large classes in a meaningful way to support the idea of singleresponsibility, 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 goingto the GAME screen.3.2. A HIGH SCORE pop-up, appearing at the end of each round, showing the scoresfrom each round, highest at the top.Additional Requirements: For higher marks: In addition to the previous, do some of thefollowing…A1. Refactor the code by adding some design patterns to enhance maintainabilityA2. Organise the Code to adhere to the MVC patternA3. 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 testsA6. 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 theimplementation. 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 sourcecode. We will look at JavaFX for two full weeks, starting in the week commencing the 9November. If you want to install JavaFX and try it out beforehand, please have a look at httpss://openjfx.io/. Here you will find information about how to install JavaFX and how to use itfrom the command line or from within the IDE of your choice. JavaFX also offers a mailing listwhere you can ask questions.Version Control: To start, please download COMP2013-BestSokobanEverV6_src.zip fromMoodle. 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 fromMoodle only provides source code and resources but no project files, as it is good practice toignore 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 schoolsGitLab server ( httpss://projects.cs.nott.ac.uk). Your remote repository is namedCOMP2013_UserName (e.g. COMP2013_pszps) and needs to be set to PRIVATE. Then followthe setup Instructions provided in GitLab to Push an existing folder (i.e. do an initial push toupload files from your local to your remote repository). Now you are ready for coding withversion control.Object-Oriented Implementation: The implementation needs to adhere to some rules. Werequire these rules because we want a good product to be delivered. When we look under thehood, he does not want to see a pile of scrap metal, but rather a finely tuned, carefully craftedmachine. You are required to follow Bobs Concise Coding Conventions. See moodle for acopy of this document. And yes, points will be deducted for magic numbers and other rules thatare not followed.Assignment Submission and OrganizationThis section describes which files need to be submitted for assignment and how they should beorganized. Remember, there are a LARGE number of students in the class, thus theorganization of your submission is very important. You are required to create a root foldercalled 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 youconducted (highlighting the key changes you made for maintenance and extension, where youmade them, and why you made them). WARNING: If you dont mention it here, dont blame uslater 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 notimplemented,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 ofthe 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 thestructure of the final version of your game (considering only classes (excluding fields andmethods, unless they are relevant for understanding design principles/patterns), interfaces,relationships, and multiplicity). If you use software to reverse engineer your class diagram, makesure the delivered diagram is correct and follows the above requirements.Project Implementation Files and Folders: A zip file containing your ENTIRE LOCALPROJECT FOLDER. It needs to be possible to IMPORT (or OPEN) and RUN your project ineither Eclipse or IntelliJ. To avoid disappointment later, test your final version on a differentcomputer. This Should help to uncover hardcoded path dependencies, which was a major issuein previous years. Name your zip file: SurnameFirstName_IDE_JavaVersion.zip, where IDErepresents the name of the IDE you used and JavaVersion the Java version you used. Here isan example: SiebersPeer_IntelliJ_15.zip.Place the .zip file in a folder called project that resides in the COMP2013surnameFirstnamefolder described above.Source Code Documentation: A copy of your Javadoc documentation submitted online isrequired. Javadoc produces a series of linked HTML web pages in order to facilitate thebrowsing of project implementations. The HTML web pages produced by Javadoc are placed ina folder called javadoc that resides in the COMP2013surnameFirstname folder describedabove. Recall that the Java output contains: (1) a brief description of each class, (2) adescription of each method including input and return parameters, and (3) the original sourcecode. 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 youmaintained and extended the game. If it is not obvious from there we might miss it. Also wehave only a limited amount Of time to look at each coursework submitted. So, please make sureto provide informative but concise Javadocs.Demo via Screen Capture: Use screen capturing software to demonstrate the features of yourapplication. The video is up to 3 minutes in length. The movie file is saved in MPEG or MP4format. Also, you can Use MPEG2 and MPEG4 compression formats. Your animated screencapture demo is called surnameFirstnameDemo.mp4 (or .mp2 or .mpg) and resides in theCOMP2013surnameFirstName folder described above. Note that the demo movie will be theprimary way in which we assess whether or not your functionality is working. The demo movieshows your software running and then (for the main part) explains your refactoring activities andadditions. You also highlight two achievements you are most proud of.Folder and File OrganizationThus, when completing the submission of the assignment, you have a directory structure in yourCOMP2013surnameFirstname folder that looks like this:README.mdDesign.pdfsurnameFirstnameDemo.mp4project/surnameFirstname_IDE_JavaVersion.zipAssessmentTo give you an idea about what we are looking for when we do the marking, we provide a draftmarking scheme as an appendix. Please note that this is only a guide for us and does notguarantee you marks when you have done certain things. There is always an aspect of qualitythat 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 ofmp4) will lead to a penalty of -2 each● Failing to comply with any naming conventions requested in this task sheet will lead to apenalty of -2 each.Important Hints NotesSource code: This coursework is about maintaining and extending existing code. So, for themaintenance part YOU HAVE TO USE THE CODE WE PROVIDE(COMP2013-BestSokobanEverV6_src.zip) as a basis, and not write your own Sokoban gamefrom scratch, or use source code from other campuses.Interview: Make sure you understand what you are writing in your code and Javadocs. Wereserve 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 givehigh 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 generalquestions 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 theCOMP2013 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 softwareon your submission. Plagiarism will not be tolerated, and academic offences will be dealt with inaccordance with University policy and as detailed in the student handbook. This means you mayinformally discuss the coursework with other students but your submission must be your ownwork. Please also note that it is not permitted for you to copy and paste text from another sourcewithout correct referencing. If you are unclear about this process, please discuss with themodule 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. Bobs Concise Introduction to Doxygen. Technical report,The Visual and Interactive Computing Group, Computer Science Department, SwanseaUniversity, Wales, UK, 2007. (available online).(Laramee, 2010) R.S. Laramee. Bobs Concise Coding Conventions (C3). Advances inComputer Science and Engineering (ACSE), 4(1):2326, 2010. (available online).Appendix: Draft Marking SchemeTechnical FAQs and Tips on the CourseworkHow to install the coursework project on your local machine – some tipsWe have made two short videos, explaining how its done in IntelliJ and Eclipse. You can find the videosin 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 thecode, perhaps using a debugger. While inspecting the code I would add any kind of understanding Igained as comments or Javadocs to the code. I would perhaps consider using a reverse engineering toolfor 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 tosupport the idea of single responsibility, improving encapsulation, and sorting out other things that areeasy to do. Then I would perhaps create a new class diagram which shows my planned alterations andextensions. Then I would go for the more difficult Maintenance and extension tasks. Then I would addsome surprises :).Bob: In addition to what Peer stated, I would also start applying the debugging guidelines we went over inthe debugging lab. Start inserting Test and m_trace flags into the classes to understand the flow of controlstarting with the Main method. Also, I would definitely create some auto-generated diagrams of of thecode using built-in diagram generators in IntelliJ or some other IDE.Some set-up help for Mac users, having issues with seeing the game windowIf you are a Mac User and you have issues with seeing the game window, go to Run as RunConfigurations… and untick the option Use the XstartOnFirstThread argument when launching withSWT. That should do the trick ;-). See attache screenshots for details.Error Message: Module xxx not foundFor this specific problem (Module xxx not found), change the first line in module-info.java to Modulexxx, since the file students download and project have a different name.Error Setting Up Project with JavaFXI 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: httpss://stackoverflow.com/questions/21713414/intellij-idea-the-selected-directory-is-not-a-valid-home-for-jdk如有需要，请加QQ：99515681 或邮箱：99515681@qq.com

“