Is there any documentation or classic help file about the components of P4D? #401
Replies: 3 comments · 6 replies
-
|
The short answer is no. You are welcome to contribute one. You may use the support forum for questions. And incidentally the Eval... methods return a result, the Exec... don't. |
Beta Was this translation helpful? Give feedback.
-
|
Ok. I want to contribute. I'm thinking of https://www.helpndoc.com/ I think that in this case, there is not any problem. |
Beta Was this translation helpful? Give feedback.
-
|
The standard way of contributing is to:
The standard way of generating component help is:
We need to decide on the tool which will determine the source code comment format. Once we do that then you can start documenting the source code, Documentation Insight supports the Delphi standard XML Documentation comments. PasDoc supports this format but also supports its own more terse format. My initial thought is to use the Delphi supported XML comments and PasDoc for output generation since it is open source and free. @lmbelo @jimmckeeth Any thoughts? |
Beta Was this translation helpful? Give feedback.
-
|
In my opinion, these types of documentation with XML and comments inside the code have some significant disadvantages: It obfuscates the code.
The design of the result format, like HTML, PDF, or CHM, does not depend on your intention as a document writer; instead is the result of a third-party decision out of your control. This must not be paranoic about the Open Source and Free obsession. Think that Dephi is not OpenSource nor Free. Integrating the help in the Delphi IDE is better to allow the final user to press F1 in the Type or Method written in the code and get the help in a standard form. This is the method of Delphi. They don't obfuscate the source code with "help content." See this starting point: Steema Help |
Beta Was this translation helpful? Give feedback.
-
|
Another disadvantage of including documentation inside the source code is that it is complicated to add authentic comments. You'll be ever writing comments with caution of not adding absurd items to the documentation. |
Beta Was this translation helpful? Give feedback.
-
|
Anyway, PasDoc seems a better option than Documentation Insight. |
Beta Was this translation helpful? Give feedback.
-
|
There are three advantages of using XMLDoc
I could try and help get a Document Insight by DevJet or Doc-o-Matic. Or you could use PasDoc. It really comes down to the preferences of who wants to write the documentation... |
Beta Was this translation helpful? Give feedback.
-
|
The XMLDoc is a great choice. |
Beta Was this translation helpful? Give feedback.
-
|
Agree. Happy to accept PRs with XMLDoc comments. |
Beta Was this translation helpful? Give feedback.
-
It is essential to have this because some doubts are difficult to understand only through the name of the method or property. Or reading and deepening inside the source code.
For example, what's the difference between EvalStrings and ExecStrings methods?
And for single questions like the previous one, it is excessive to investigate through many demos or a mountain of tutorials. We often need short and direct responses, like the ones we found in a help file or a manual.
Beta Was this translation helpful? Give feedback.
All reactions