As a fresher at FICO, Rahul and I had developed a java source code analyzer named My Code Rules. The objective was to develop a rule engine which would apply a set of rules to find inconsistencies in a given set of java source files. An API for writing of new rules was also developed. A few sample rules were created by us to show the effectiveness of the rule engine.
Now one of the rules was to check if the methods have been documented or not. One could provide in a config file the type of functions [public, private, protected, all] that needed to be analysed The rule engine would then look up all the filtered methods and display as a table the list of methods that had not been documented.
I finally got to use the tool today 
. I needed to check if I had documented the my code. This tool quickly listed all the methods that needed documenting. I searched for the ones I had added and my work was done!
Sadly though, I have never had the time to improve the tool. Both Rahul and I were new to java when we wrote the tool, and our amateurishness shows in our design and the implementation. After Rahul FICO, the old code was beyond repair. I tried a fresh approach, correcting the previous errors, trying to look ahead, but it requires a lot of time and dedication. The project lives in a deserted state.
Popularity: 2% [?]
Related posts: