Our code contains all the choices that have been made to e.g. create the various columns during enrichment. Instead of writing separate documentation for the functionality of our system, one may embed the explanation for each choice close to the code as comments, and those comments are processed by an external programme to create one larger document from the pieces scattered in the code.
Such comments-to-document comments could look something like this (in R)
# @codedoc_comment_block column_icd10
# Column icd10 is created by using the IARC CRG Tools "ICD-O-3 -> ICD-10" conversion tool.
# @codedoc_comment_block column_icd10
and the external programme to collate all the documents simply identifies lines with the @codedoc_comment_block keys.
Our code contains all the choices that have been made to e.g. create the various columns during enrichment. Instead of writing separate documentation for the functionality of our system, one may embed the explanation for each choice close to the code as comments, and those comments are processed by an external programme to create one larger document from the pieces scattered in the code.
Such comments-to-document comments could look something like this (in R)
and the external programme to collate all the documents simply identifies lines with the @codedoc_comment_block keys.