Skip to content

Expand rules to other types of files #19

@fanny

Description

@fanny

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions