How to: Comment code

[ToLearn]

This isn't a question, but a how to. It only works with code that would normally work and won't allow you to add plain English code.

Most who has programmed or most people who have even played with HTML "code" are familiar with comment codes. If you typed some code you wanted to keep, but wanted the computer to ignore you could simply add // in front of and at the end of it or put a special character before and after. I had asked a while ago if it was possible to do in the Apex and I was told it wasn't.

While it may not be possible to do a true comment code(where you could even insert plain human language that the computer would ignore) this will essentially nullify any Apex programming. It will not work with the defer statement or other syntax not evaluated in chronological order.

Example say something that is on always unless Feed is on you occasionally wanted off a certain time of day this would be the normal code:

Fallback ON
Set ON
If Time 22:52 to 22:54 Then OFF
If FeedA 000 Then OFF

This would essentially be the If statement commented out:

Fallback ON
If Time 22:52 to 22:54 Then OFF
Set ON
If FeedA 000 Then OFF

Same thing would work if you had a faulty pH probe and didn't have a replacement laying around and you want the Apex to ignore those statements until you can get a new probe:

(SndAlm_I6)

If pH > 08.35 Then ON
If pH < 07.80 Then ON
Set OFF
If Outlet TopSumpFloat = OFF Then ON
If Outlet ATO_TooLong = ON Then ON
If Temp > 82.2 Then ON
If Temp < 77.5 Then ON
If ORP > 499 Then ON
If ORP < 240 Then ON
If Power EB8_5 Off 001 Then ON
If Power Apex Off 000 Then ON




What would be really really nice is if Neptune could put a true comment code working with // or ", but until then we'll have to use work arounds. Perhaps if enough people bug them about it...

Neptune's contact form.

 

[z3r0ko0l]

wow, Ive been looking for this! Thanks.

 

[CalmSeasQuest]

Thats been on our wish list for quite a while. I'd also like the ability to annotate graphs.

Ultimately either enhancements to the Apex, or a compatible Aquanotes type application to allow combining tank data and notes into a central location would be a great improvement.

 

[Jocko]

Oh haha I initially thought you wanted to put comments in your code and I thought that was a little extreme. But I see what you're saying, you want to be able to comment certain lines out.

In the meantime maybe you could identify particular areas of your code that you might want to comment out and then move the logic into virtual outlets, so then if you ever wanted to "comment it out" you could just turn the virtual outlet off? Although yeah that's not quite as handy as pre-pending "//" or something. Heh.