Recent

Author Topic: How can CodeTools to create a documentation block at the start of a function?  (Read 2695 times)

vfclists

  • Hero Member
  • *****
  • Posts: 1013
    • HowTos Considered Harmful?
How can get a CodeTools to create a documentation block around a function e.g say I have a function like this.

Code: Pascal  [Select][+][-]
  1. procedure SomeProc(a: string, b: string: c: integer)
  2. var
  3.   d,e: string
  4.   g, h: integer;
  5. begin
  6.  --- etc
  7.  
I want the CodeTools to creat something like this

Code: Pascal  [Select][+][-]
  1. {
  2.    SomeProc : enter short description of function and some notes about it.
  3.     a: enter parameter description here
  4.     b: enter parameter description here
  5.     c: enter parameter description here
  6. }
  7. procedure SomeProc(a: string, b: string: c: integer)
  8. var
  9.   d:  string //descripton of d
  10.   e: string //description of e
  11.   g: integer; // description of g
  12.   h: integer; // description of h
  13.   h:
  14. begin
  15. ...

In fact it would be better if it was accomplished by an interpreter, so I would'nt have to go through the compilation phase to fix it.
Lazarus 3.0/FPC 3.2.2

Leledumbo

  • Hero Member
  • *****
  • Posts: 8757
  • Programming + Glam Metal + Tae Kwon Do = Me
I don't think it has such a functionality (even though it can display the documentation), you should extend codetools for it (make a package for modularity, please). Remember, the team prefers separated documentation instead of inline, which is why integrated documentation editor exists and fully supported.

Christophe

  • Newbie
  • Posts: 2
Favorite work online without having to travel.

 

TinyPortal © 2005-2018