Bug 569209 - code comments should also be checked
Summary: code comments should also be checked
Status: NEW
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: titan.plugins (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows 10
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-11-26 07:57 EST by Kristof Szabados CLA
Modified: 2021-04-23 11:10 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Kristof Szabados CLA 2020-11-26 07:57:20 EST
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.
Comment 1 Denis Roy CLA 2021-04-23 11:10:15 EDT
This bug was migrated to GitLab: https://gitlab.eclipse.org/eclipse/titan/titan.EclipsePlug-ins/-/issues