Ichthyostega
b556d2b770
Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
98 lines
2.4 KiB
Text
98 lines
2.4 KiB
Text
Design Process : Coding Style
|
|
=============================
|
|
|
|
[options="autowidth"]
|
|
|====================================
|
|
|*State* | _Final_
|
|
|*Date* | _2007-06-27_
|
|
|*Proposed by* | ct
|
|
|====================================
|
|
|
|
|
|
|
|
|
|
CodingStyle
|
|
-----------
|
|
Define coding style standard which we will use.
|
|
|
|
|
|
|
|
|
|
Description
|
|
~~~~~~~~~~~
|
|
We need to agree on some coding style, IMHO consistency is the most important
|
|
part with this, no matter which style we use.
|
|
|
|
See https://en.wikipedia.org/wiki/Indentation_style[Wikipedia: Indentation Style]
|
|
|
|
.Notes:
|
|
* no tabs, use spaces!
|
|
|
|
.Proposed:
|
|
* K&R by _ichthyo_
|
|
** compact and well known
|
|
* GNU by _cehteh_
|
|
** imo the best readability (albeit little strange)
|
|
** Lumiera might apply as official GNU project someday
|
|
|
|
|
|
Another question: __how to write identifiers?__
|
|
|
|
.Proposed:
|
|
* ichthyo: use CamelCase, start ClassNames upper case and variableNames
|
|
in lower case. Make all namespaces and package (dir) names completely lowercase
|
|
|
|
|
|
|
|
|
|
Tasks
|
|
^^^^^
|
|
* Bouml config to generate this style
|
|
* footers (or headers) to configure common editors to use this style by default
|
|
|
|
|
|
|
|
|
|
|
|
Conclusion
|
|
----------
|
|
we agreed on GNU style
|
|
|
|
CT:: '2007-07-03 04:04'
|
|
|
|
|
|
|
|
|
|
Comments
|
|
--------
|
|
Since ct called spaces instead of tabs first, we should stick to that. I
|
|
think all other reasons will lead us to nowhere!
|
|
|
|
Although I'm used to a BSD/KNF-like coding style I will try the GNU one. After
|
|
all, the wikipedia page mentions no disadvantages of that style 😊
|
|
|
|
MichaelPloujnikov:: '2007-06-27 17:17'
|
|
|
|
|
|
I just proposed K&R because it is widely accepted. Personally, I was never very
|
|
fond of K&R style, I always preferred putting opening braces to the left. I
|
|
never used GNU style until now, but it looks somewhat appealing to me. (btw,
|
|
ECLIPSE comes with presets for all this styles 😛 ). Anyhow, I can adapt to
|
|
most any style. The only thing I really dislike is using tabs (with the
|
|
exception of database DDLs and CSound files, where tab are actually helpful) 😊
|
|
|
|
Ichthyo:: '2007-06-27 20:55'
|
|
|
|
|
|
Many years later -- we are still using GNU style and over time have developed
|
|
a »Lumiera flavour« which plays well with C++, templates and λ-functions.
|
|
A striking consequence is that the code looks light, favours short functions,
|
|
is rather vertically oriented and is easy to skim while scrolling.
|
|
|
|
-> see our link:/x/CodeStyle.html[Style guide].
|
|
|
|
Ichthyo:: '2025-09-05'
|
|
|
|
|
|
''''
|
|
Back to link:/x/DesignProcess.html[Lumiera Design Process overview]
|