Last Modified: 29.08.2019
When working with Bitrix Framework API description is of major importance. Unfortunately, API descriptions of new functionality are never issued simultaneously with the functionality. There are several reasons for that:
- It is impossible to write API and the functionality itself at the same time;
- Writing API immediately after issuing a functionality is not practical, because soon after its issue many bugs are found; they require corrections and, accordingly, these corrections must be taken into account in the documentation.
As a rule, API is written some time (usually two or three months) after release. Unfortunately, it also occurs that the old functionality is not described fully and correctly. For example, changes were made but not included in the documentation.
Thus, the only solution for the developer consists in reviewing the code itself.