Timeline for Is it good practice to comment with issue number?
Current License: CC BY-SA 3.0
3 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Jan 19, 2023 at 14:41 | comment | added | Mikko Rantalainen | But function level comments (docblock) should be enough for most cases because you can create function called detectAndWorkaroundXIfNeeded() which is self-documenting on the calling site. For complex enough X, trying to encode it in the function name is not going to fly, though. | |
| Jan 19, 2023 at 14:38 | comment | added | Mikko Rantalainen | Even with clean code, adding comments about implementation may be valuable. For example, in a code that needs to interact with 3rd party program, it makes a lot of sense to add a comment that the implementation needs to do X to be compatible with weird edge case behavior of that 3rd party program. The important part is to explain why the code is written as-is, not how the code is written because it can be read from the code or version history. | |
| May 2, 2012 at 2:20 | history | answered | S.Robins | CC BY-SA 3.0 |