How does one put "Documentation" for a particular piece of code

In builder one could basically use the Documentation script that is part of every object and put in comments so when you want to look or create children that would inherit the comments and it was pretty useful.In CSIDE it does seem to be there but I cannot seem to make use of it.Meaning it wont get thrown in the Object area where you are making code nor does objects sub classed of it seem to remember the previous.

To me it does not matter if it worked like builder did.I am trying to put some programming notes on Objects when I code which helps understanding at a later date.

If this helps I tried to put what I see in the attached word document.

Kindly tell me if I am approcahing this wrong or not

Builder View.docx

Find more posts tagged with

Comments

Darcy_Casselman

You're not wrong. This is an oversight I'm kind of surprised we (the CSIDE dev team) haven't heard about before now. How to show inherited Documentation scripts for objects is an open question. Right now, you can navigate through the object hierarchy to read them. Unfortunately, there's no easy "Show in > Inheritance View" in the OScript Source Editor yet. You need to get to it via the Module Explorer. You can also hit F3 in any object name (including the one in the inherits clause) to go to that source file if you have it, which is fewer clicks but also not terribly intuitive.One thing we've planned to do for a while is add a hover for object names showing the documentation string. So you could hold the mouse over the object name in the inherits clause, you'd be able to see the documentation for that object. Inherited (but not overridden) Documentation scripts will show in the upcoming Outline view, but you can't do anything useful with them at the moment. Maybe we put a hover there, or give you a way to view inherited scripts there. In general, we do want to discourage scripts that aren't scripts. Because that gets messy and confusing in the new world of flat source files. Which is why we added things like long strings (with backquotes (`)). Moving the documentation script to the top of the file in a comment seemed logical and obvious. But you're right, people expect to be able to read the docs for parent objects in OScript more than one might expect in other languages. Darcy.

Darcy_Casselman

I should probably add that in a future rev of the OLL format, we're planning on removing Documentation as a script and storing it somewhere else as object metadata instead.

(I say this with the usual caveats about forward-looking statements and not being a promise of future requirements. Lots of factors go into what makes it into a release. I just want to let you know where we're thinking of driving this thing).

Darcy.

Appu_Nair1

Thanks as always and hope the newer product does allow programmers to put in comments for posterity

Darcy_Casselman

The comments are definitely there and are preserved. We're still creating Documentation scripts (for now). Javadoc ("/**") style comments on scripts continue to be stored in the script feature (again, for now). It's just now they get surfaced in the IDE UI needs some more thought and design.