search

cms-sw / cms-sw.github.io

Documentation for CMSSW
22 stars 59 forks source link

Documentation/comment code style rules #101

Open slava77 opened 2 years ago

slava77 commented 2 years ago

https://cmsdoxygen.web.cern.ch/cmsdoxygen/ is apparently still maintained/supported

What is the general feeling to still keep supporting the doxygen style comments in the code?

I frequently recall to ask for it in the DataFormats headers. (to use /// or //!) However, I do not see it mentioned in the https://cms-sw.github.io/cms_coding_rules.html

Should this be formalized in the rules?

slava77 commented 2 years ago

@smuzaffar @makortel please clarify if this is considered.

slava77 commented 2 years ago

ping

slava77 commented 2 years ago

@smuzaffar @makortel please clarify if this is considered.

ping

smuzaffar commented 2 years ago

Yes cmsdoxygen is still ailve but my general feeling is that LXR and DXR has replaced it. Regardless of we keep doxygen alive or not, it is true that we never had any clear rule/recommandation for documentation/comment style. The coding rules were initially drived from the 1998 CMS Style rules which is also not recomanding any comment style.

I agree, we should add some guide lines for documentation/comments style in our code rules.