View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0006364 | Taler | libeufin (general) | public | 2020-06-04 16:37 | 2023-04-13 21:46 |
| Reporter | MS | Assigned To | |||
| Priority | none | Severity | text | Reproducibility | have not tried |
| Status | new | Resolution | open | ||
| Target Version | 0.9.6 | ||||
| Summary | 0006364: Comments style. | ||||
| Description | From 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. | ||||
| Tags | No tags attached. | ||||
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2020-06-04 16:37 | MS | New Issue | |
| 2020-11-10 12:18 | MS | Target Version | => 0.9.3 |
| 2023-01-08 11:23 | Christian Grothoff | Target Version | 0.9.3 => 0.9.6 |
| 2023-04-13 20:29 | Florian Dold | Project | libeufin => Taler |
| 2023-04-13 21:46 | Florian Dold | Category | other => libeufin (general) |
