View Issue Details

IDProjectCategoryView StatusLast Update
0006364libeufinotherpublic2020-11-10 12:18
ReporterMS Assigned To 
PrioritynoneSeveritytextReproducibilityhave not tried
Status newResolutionopen 
Target Version0.4 
Summary0006364: Comments style.
DescriptionFrom a private conversation:

I've seen that some comments in LibEuFin use the

/**
 * foo
 * bar
 */

style. While this is not really a big issue, I just wanted to mention
that comments beginning with "/**" usually indicate doc comments. That
is, comments that are relevant to the documentation generator (doxygen,
dokka, ...).

As such, it's better style to use "//" comments or "/*" comments (single
start) for comments that just explain what's going on inside the code,
as opposed to comments that represent the documentation for some
"documentable" element, such as functions, class members, etc.
TagsNo tags attached.

Activities

There are no notes attached to this issue.

Issue History

Date Modified Username Field Change
2020-06-04 16:37 MS New Issue
2020-11-10 12:18 MS Target Version => 0.4