ImageEn for Delphi and C++ Builder ImageEn for Delphi and C++ Builder

 

ImageEn Forum
Profile    Join    Active Topics    Forum FAQ    Search this forumSearch
 All Forums
 ImageEn Library for Delphi, C++ and .Net
 ImageEn and IEvolution Support Forum
 Compact declaration vs. Self-documenting declaration

Note: You must be registered in order to post a reply.
To register, click here. Registration is FREE!

View 
UserName:
Password:
Format  Bold Italicized Underline  Align Left Centered Align Right  Horizontal Rule  Insert Hyperlink   Browse for an image to attach to your post Browse for a zip to attach to your post Insert Code  Insert Quote Insert List
   
Message 

 

Emoji
Smile [:)] Big Smile [:D] Cool [8D] Blush [:I]
Tongue [:P] Evil [):] Wink [;)] Black Eye [B)]
Frown [:(] Shocked [:0] Angry [:(!] Sleepy [|)]
Kisses [:X] Approve [^] Disapprove [V] Question [?]

 
Check here to subscribe to this topic.
   

T O P I C    R E V I E W
PeterPanino Posted - Sep 14 2025 : 15:10:37
Dear Nigel, in the CHM documentation you use a COMPACT declaration, e.g.:

function ImportFromFileSVG(const FileName: WideString; Width: Integer = -1; Height: Integer = -1; MaintainAR: Boolean = False): Boolean;

Please use a Self-documenting declaration type instead. For example:



This is much clearer, and the user doesn't need to consult separate text paragraphs to understand the parameters.
1   L A T E S T    R E P L I E S    (Newest First)
xequte Posted - Sep 15 2025 : 00:29:13
Hi Peter

I think everyone has their preferred style for declarations. The one above is quite useful for complex methods with lots of parameters, and a similar style appears in the documentation in a few places. I'll consider more use of it going forward.

Nigel
Xequte Software
www.imageen.com