#Coding Guidelines

The topic of for/while loop performance in Caché ObjectScript came up in discussion recently, and I'd like to share some thoughts/best practices with the rest of the community. While this is a basic topic in itself, it's easy to overlook the performance implications of otherwise-reasonable approaches.

Hi, Community!

I'm pleased to share that we have a dedicated InterSystems Developer Community GitHub - github.com/intersystems-community!

As a developer, usually I'm concerned about how my code health is, and how the other coders code can affect to my own work. And I'm quite sure most of us feel very similar.

In our company we use a Static Code Analysis tool to analyze code for different languages to ensure we are writing high quality and easily maintainable code by following a few best practices in terms of code structure and content. And the question was: why should be different for Caché ObjectScript language?

This a spin of from For and If with one line: to brace or not to brace
Has anyone seen or heard of a Beautifier for Object Script?

There is a bunch of them out for XML, HTML, JavaScript, CSS, PHP, .... https://codebeautify.org/

I need to create a standards document for new developers who are coming to Cache from other backgrounds.

Does anyone have an in-house document they could share with me?

Regards

Mike

Hi Community!

We are proud to annouce our latest release of CachéQuality to help you to find and solve coding errors, refactoring, help to follow you coding guidelines, etc. You can check the latest release notes here.

Hi Community!

Sometimes I meet a method which accepts 10+ parameters.

And often I need only the 8th parameter to pass. And I call the method something like:

do ##class(Some.Feature).Method(,,,,,,,"flag")

And I don't like this method when I call it like this cause, you know, often I just miss the number of commas and raise some other flag I wanted.

How do you avoid this situations?

If you meet such a code, how do you call it and sure that you didn't miss the number of ","?

What is a good number of parameters in a method and f you need to pass more parameters in a method what do you do?

A SOLID Design in Cache Object

In this session, we will discussing SOLID Principle of Programming and will implement in a example.
I have used Cache Object Programming Language for examples.
We will go step by step to understand the requirement, then what common mistakes we use to do while designing, understanding each principles and then complete design with its implementation via Cache Objects.

Hi everyone,

Are there any tools to check the code coverage and to do a lint check for cache object script? Developers will be working with HealthConnect (IRIS based)

Thanks.

Documentation here lists the kinds of members a class definition may contain. In summary:

• Parameters
• Methods
• Properties
• Class queries
• XData blocks
• Projections
• (and some that are relevant only for persistent classes):
  • Storage definitions
  • Indices
  • Foreign keys
  • SQL triggers

Later in the same document, a section headed "Class Member Names" contains this warning:

When I'm writing code in Intersystems Studio code completion is different than in VS Code. It would be greate if VS Code would react the same way on code completion .. This happens is studio

When I do this in VS Code it doesn't show the object but it shows ?? all possible items ??

Hi community!

Is it possible generate HTML documentation to my project ObjectScript classes (.cls)?

In Java we use Javadoc to do it. Javadoc get class comments and java metadata information and when I execute javadoc -d doc src\*, I get whole html documentation to my classes. Has IRIS something like javadoc? Is it documatic? If yes, how can I use it?

Hello community,

Our organization is looking to expand our Coding Standards to be more in alignment with best practices.

I was wondering if the there are developers here that would not mind sharing any existing documents. Our scope would be this document be applicable to new hires learning Cache all the way up the chain.

Thanks in advance,

-SH

Say I have a property in a persistent class that stores list of colours and I would like to query that field and return a list and be able to loop that list to get individual colours how will l go about achieving this I have tried something like this but its not working as expected

 &sql(SELECT colour INTO :colourList FROM favouritecolours)
 While (SQLCODE = 0) 
{
 for i=1:1:$LENGTH($P(colourList,","))
 {
 set fvalue=$P(colourList,",",i) 
write "the first"_fvalue,i, 
} 
}