---

General

About COMTOR

What does COMTOR stand for?

COMTOR is short for COmment MenTOR.

What features does COMTOR measure?

Click here to check out what features we measure.

Who created COMTOR ?

COMTOR was developed by computer science students at The College of New Jersey working under the direction of Dr. DePasquale. Check out the About page for the complete history of COMTOR.

Why should I use this system?

The detailed use of documentation is a significantly underestimated way of improving software quality. COMTOR attempts to assist students in learning how to create quality documentation for their source code, by evaluating submitted source code against an overall standard.

Who will benefit most from this system?

We believe that computer science majors at any level can benefit from using this system.

Is COMTOR an open source project?

Yes. Comment Mentor's code is licensed under the terms of the GNU GPL, version 2. The source code is distributed as the software download itself, and you are free to make changes to the software, as long as your changes are distributed under the GPL. You can also find COMTOR on SourceForge.net.

I saw an icon I didn't understand. What does it mean?

Edit
View
Disable or Lock
Enable or Unlock
Delete

Account Management

How do I create an account?

Click Create An Account on the left navigation bar and fill in the fields.

Do I have to enter my college email address?

No. You can enter any valid email address.

Troubleshooting

Where should I report bugs?

COMTOR is still in development. If you notice some bugs or other problems we would like to know. Please send us a quick email describing the bug.

COMTOR keeps telling me my username does not exist. Why can't I log in?

Make sure you are typing the email address you signed up with correctly. If you have not signed up you will need to create an account before you log in.

I forgot my password. Now what do I do?

Click on Password Recovery on the left navigation bar and enter your email address.

I created an account and entered my email and my email password. Why can't I log in?

Please check your email for a temporary password once you create your account. You can then use your email address for the username and enter the provided temporary password in the password field.

I created an account but no temporary password was sent to my email. How do I retrieve my account?

You may have mistyped your email address. A common mistake is accidently entering .com instead of .edu or vice versa. Please try creating an account again.

COMTOR says my code does not compile, but I know it does. What should I do?

Make sure once again that the code you are trying to upload does compile. You may be accidently uploading an old version of your code. Also make sure that you have included all nonstandard packages in the JAR file.

Where is my professor's dropbox?

Please see the video tutorials section, which includes a tutorial on how to submit an assignment to a dropbox.

Why do I always get points deducted for not commenting main?

public static void main (String[] args) actually is a function and thus should be commented using the appropriate Javadoc tags.

Students

Clases and Submissions

How do I join a class?

1. Login (if you have not already created an account please create one).
2. Click Courses under Course Management in the left hand navigation bar.
3. Find the appropriate course and click Enroll.
4. The system will then prompt you with a message box asking if you want to enroll.
5. Click OK.

How do I submit source code to a professor's dropbox for analysis?

1. Login (if you have not already created an account please create one).
2. Click on the appropriate course in the listing displayed on the welcome screen.
3. Click on Add New Assignment.
4. Select your JAR file.
5. Select the appropriate assignment dropbox.
6. Click the checkboxes to include modules.
7. Click the Analyze Comments button.
8. View your report and submitted source code.

What types of source code can I submit to COMTOR?

Currently COMTOR only evaluates Javadoc comments in Java source code.

What is a Javadoc comment?

Check out the Javadoc pages.

How do I compile and run a Java program?

Click here for more about compiling and running Java programs.

What is a JAR file?

Click here for more about JAR files.

Instructors

Account Management

How do I obtain instructor status?

If you have an account,

1. Click Requests under Account Setup in the COMTOR menu to the left.
2. Change the account type to professor and enter a small amount of text that we can use to verify that you are a professor.
3. Click the Request Account Type Change link.
4. Your request will be displayed on the page. Please wait until an administrator can process your request.

If you do not have an account,

1. Create an account in the regular way.
2. Check the Request Professor Status checkbox and enter a small amount of text that we can use to verify that you are a professor.
3. Please wait until an administrator can process your request.

What type of link should I provide for professor status verification?

Please provide a link to a website that shows that you are professor at a given institution. This website also needs to have your email address listed, which should match the email address you provided for your username.

How do I choose what types of emails I receive from COMTOR?

1. Click E-mail Notifications under Account Setup in the COMTOR menu to the left.
2. Select the frequency that you want to be sent emails.
3. Select the events for which you would like to receive emails.
4. Click the Submit button.

Course Management

How do I add a course?

1. Click on Add Course under Course Management in the COMTOR menu to the left.
2. Fill in the required information and click the Submit button.

How do I edit course information?

1. Click Courses under Course Management in the COMTOR menu to the left.
2. Find the course you would like to edit and click the pencil icon in the right column.
3. After editing the information, click the Submit button.

How do I enroll students in a course?

1. Click Courses under Course Management in the COMTOR menu to the left.
2. Find the appropriate course and click the magnifying glass icon in the right column.
3. At the bottom of the page, click the link for Enroll Additional Students.
4. Find the student you wish to enroll and click the Enroll link next to their name.

How do I drop students from a course?

Please note that this will disassociate all submissions from the course. This cannot be undone.

1. Click Courses under Course Management in the COMTOR menu to the left.
2. Find the appropriate course and click the magnifying glass icon in the right column.
3. Find the student you wish to drop and click the Drop Student link next to their name.

How do I view a student's dropbox?

1. Click Courses under Course Management in the COMTOR menu to the left.
2. Find the appropriate course and click the magnifying glass icon in the right column.
3. Find the student's name and click the View Dropbox link next to it.

How do I send emails to students in a course?

1. Select the appropriate course from the select box in the top right corner of the page.
2. Click E-mail in the Modules menu to the left.
3. Select the students you would like to email (Hold Ctrl to select multiple students).
4. Fill in the subject and the message and press Submit.

Assignment Management

How do I add an assignment?

1. Select the appropriate course from the select box in the top right corner of the page.
2. Click View Course Dropbox in the Modules menu to the left.
3. Click Add New Assignment at the top of the page.
4. Fill in the name and the open and close dates for the assignment.
5. If you want specific modules to be run, check the checkbox next to the modules to be run.
6. Fill in the grading information and parameters if you do not wish to use the default values.
7. Click the Submit button.

How do I edit an assignment?

1. Select the appropriate course from the select box in the top right corner of the page.
2. Click View Course Dropbox in the Modules menu to the left.
3. Click Edit next to the assignment you wish to edit.
4. Edit the assignment information.
5. If you want specific modules to be run, check the checkbox next to the modules to be run.
6. Fill in the grading information and parameters if you do not wish to use the default values. (Note: You may not edit these values if there has already been a submission for this assignment.)
7. Click the Submit button.

How do I delete an assignment?

1. Select the appropriate course from the select box in the top right corner of the page.
2. Click View Course Dropbox in the Modules menu to the left.
3. Click the Delete link next to the assignment you wish to delete. (Note: This will disassociate all reports for this assignment from the course. This cannot be undone.)