code comments should also be checked
Submitted by Kristof Szabados
Link to original bug (#569209)
Description
Right now Titan is only checking the TTCN-3 and ASN.1 code itself, but not the code comments within such file for quality. This can create issues, where for example:
-
the documentation of a function lists different formal parameters than the function has. -
the documentation is full of grammatical errors. -
the documentation might not actually belong to where it is currently placed
Titan should check for such anomalies. It should be possible to check the the formal parameters listed in the documentation against the actual formal parameters using the semantic database present in the Eclipse plugins. Also eclipse does offer grammatical checking for comments ... a functionality that might also be callable from the Designer plugin itself. And with some NLP it might also be possible to detect if the documentation is describing something completely different from the function where it is located.
Version: 7.1.0