Hi, want to get your opinion about documentation b...
# multiplatform
a
Hi, want to get your opinion about documentation best practices with multiplatform code. Do you document both expect/actual classes? If yes, do you document functions in expect/actual as well? Note. By documenting, I mean kdoc.
l
Document what you need to be documented for your code to be clear for others (and for yourself when you get back to it later). There are no general guidelines. If you just want to document what the function does for its caller (what parameters it takes, what it returns and what it actually does), I would document it only for
expect
part (as kind of internal API documentation). If you want to document some implementation details (which are only in the
actual
part) then you can describe them there.
👍 1