Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 2.93 KB

V&V.md

File metadata and controls

65 lines (43 loc) · 2.93 KB

Description

Our system will allow the user to upload .c files to be analyzed by our code formatter algorithm. The website will provide feedback and suggestions for how the user can improve their code. The user will have an account on our website and all files uploaded will be stored for later download. The website has options for users to delete their file from the database. Our website also allows users to submit feedback to the developers.

Verification (tests)

Verification aims to ensure that you correctly developed the product.

Unit test

Test framework you used to develop your tests (e.g., JUnit, unittest, pytest, etc.): Jest

Link to your GitHub folder where your automated unit tests are located: link

A print screen showing the result of the unit tests execution:

image

Validation (user evaluation)

Script:

Question 1: Please create an account and upload a .c file to be formatted. What are your thoughts on the account creation process?

Question 2: Take a look at the output, what are your thoughts about it regarding the format, appearance, and ease of readability?

Question 3: Download the file you uploaded. What are your thoughts on the download process?

Question 4: What are your overall thoughts on the system? What would you change about it and what do you like best?

Results:

Client 1: Senior Developer at SalesForce

Pros:

  • Well-written code with proper comments in C GNU format
  • Proper use of lowercase and semicolons
  • Good use of white spaces and inline comments
  • Self-documenting code

Cons:

  • No header comment at the top of the file
  • No brief header block comment at the top of each function and typedef

Client 2: Application Developer for NAUgo

Pros:

  • Easy to use and intuitive code formatter
  • Accurate and well-organized formatting output
  • Efficient and able to handle a wide range of C files

Cons:

  • Limited error handling capabilities
  • Inadequate documentation on the features and options available

Client 3: College Data Structures Student

Pros:

  • Very easy to use and time-saving code formatter
  • Accurate and consistent formatting output
  • Useful feedback on errors and warnings in the code

Cons:

  • Inability to handle complex C files
  • Limited customization options for fine-tuning the formatting

Reflections:

Overall, our users enjoyed how easy to use and intuitive our system is. In addition to this, they enjoyed the format of the output and how accurate, consistent, and well-organized it is. When it comes to what they didn’t like, the general consensus was that our system is not capable of handling as many limitations as some would like. One significant drawback was that our system struggles to handle large/complex c files.