Style/ru

From KolibriOS wiki
Jump to navigation Jump to search

Стиль оформления

Рекомендации по оформлению кода.

При написании процедур необходимо перед процедурой указывать входные, выходные параметры, так же указывать какие регистры изменяются.

;in:  eax = pointer
;     ebx = PID
;out: eax = return code in (0,-1)
;destroys eax
;================================
subrutine:

При написании процедур очень полезно комментировать их способом, показанным ниже.

Тогда даже человек, только начинающий изучать ассемблер, сразу поймёт, что далет данная функция. И наоборот даже самому опытному программисту может понадобится некторое время просто на понимание того, что делает данная функция.

;-----------------------------------------------------------------------------
proc key.ctrl_o ;///// ENTER OPEN FILENAME ///////////////////////////////////
;-----------------------------------------------------------------------------
  ...
  ...
  ...
endp