Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand rules to other types of files #19

Open
fanny opened this issue Nov 11, 2020 · 0 comments
Open

Expand rules to other types of files #19

fanny opened this issue Nov 11, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@fanny
Copy link
Collaborator

fanny commented Nov 11, 2020

Why I need this feature?

Currently, moenda just has verifications to general files and markdown files, I think that would be valuable to have functions to other languages as well, e.g, at UFCG, we use a lot Python and Java, so if we have functions/rules to those type of files could be very useful for us.

For example, one rule that might me useful for Java is to check if there's a JavaDoc.

Why I need this feature?

Improve the current process that teachers and students use to evaluate if there's some documentation in code.

How should we implement it?:

The rule will look into the Java file and see if there are comments in the format of JavaDoc, this should be useful, e.g, to see if there's some documentation for a file not. So, the rule would check if there's a string in this format /**....**/ in the file.

Additional Context:

FileA.java

/**
  This method does that ....
**/
private static string aaa(){}

should return that the file contains JavaDoc(we are not looking how well documented the function or class it's)

FileB.java

// This method does this
private static string aaa(){}

shouldn't return that the file contains JavaDoc

@fanny fanny added the enhancement New feature or request label Nov 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant