ETSI's Bug Tracker - Part 01: TTCN-3 Core Language
View Issue Details
0008094Part 01: TTCN-3 Core LanguageNew Featurepublic04-05-2022 09:0326-01-2024 16:25
Matthias Simon 
Jens Grabowski 
normalminorhave not tried
assignedopen 
 
 
none so far
Nokia - Matthias Simon
0008094: Provide a canonical style for source code layout
A clear recommendation how TTCN-3 source code should be formatted would be beneficial:

* Tool-vendors had a solid ground to implement automatic formatter tools.

* Less time would be spent on "bike-shedding" discussions (e.g. tabs vs. spaces).

* A canonical style improves readability of TTCN-3 source code (e.g. of conformance tests, code examples, ...).








No tags attached.
Issue History
04-05-2022 09:03Matthias SimonNew Issue
16-08-2022 13:37Jens GrabowskiNote Added: 0016226
16-08-2022 13:38Jens GrabowskiAssigned To => Jens Grabowski
16-08-2022 13:38Jens GrabowskiStatusnew => assigned
16-08-2022 14:13Jens GrabowskiProjectTTCN-3 Change Requests => Part 01: TTCN-3 Core Language
11-11-2022 13:09Jens GrabowskiNote Added: 0016312
11-11-2022 15:12Matthias SimonNote Added: 0016313
26-01-2024 16:25Olivier GenoudNote Added: 0016605

Notes
(0016226)
Jens Grabowski   
16-08-2022 13:37   
TTF discussion: Nice to have, possibly these guidelines may be put into an annex (style guide) together with valuable compiler switches.
(0016312)
Jens Grabowski   
11-11-2022 13:09   
TTF discussion: Code style should not become part of the standard. Maybe guidelines should be added to the TTCN-3 Web pages in the same manner as the already existing naming conventions.
(0016313)
Matthias Simon   
11-11-2022 15:12   
I might have put my CR into the wrong category/project. It is not my intention to standardize a specific code style.

Adding the recommendations to the web pages is a good idea, clearly.

We agree on recommending a preferred/canonical code style, but details about what style and where to put it are still to be figured out. Correct?

So the next step would be creating a recommendation draft?
(0016605)
Olivier Genoud   
26-01-2024 16:25   
Core language shall not be mixed up with coding style guides and in general the coding style shall be project specific. Nevertheless, a configurable 'beautifier' tool could be helpful, e.g. to achieve a common indentation.