Code Formatting - Functions with long Parameter Names, or many Parameters

robbonick · 2018-07-06

Hi,

I am just wondering what the best practice is for formatting of code, I have tried to search the coding guidelines for this, but found nothing.
My question is, say I have a function called "SomeVeryVeryVeryLongFunctionName", which returns a boolean.

This then has 4 parameters, which are populated by values from a record.

So the code would look like this...

Variant 1

IF SomeVeryVeryVeryLongFunctionName(ItemLedgerEntry."Posting Date", ItemLedgerEntry."Entry Type", ItemLedgerEntry."Document Type", ItemLedgerEntry."SourceNo") THEN BEGIN
  DoSomething();
END;

What are the guidelines for separating this function on to two lines, or more?
Or is it all a matter of opinion?

For instance should it be something like this...

Variant 2

IF SomeVeryVeryVeryLongFunctionName(
  ItemLedgerEntry."Posting Date", 
  ItemLedgerEntry."Entry Type", 
  ItemLedgerEntry."Document Type",
  ItemLedgerEntry."SourceNo") THEN BEGIN
    DoSomething();
END;

or this...

Variant 3

IF SomeVeryVeryVeryLongFunctionName(ItemLedgerEntry."Posting Date", ItemLedgerEntry."Entry Type", 
  ItemLedgerEntry."Document Type", ItemLedgerEntry."SourceNo") THEN BEGIN
    DoSomething();
END;

Juhl · 2018-07-06

Variant 1 dosent make sense to me, but your right.
Try to look at new code. Ex. Codeunit 80 has been rewritten, and it uses variant 3.
NAV still contains old code.

But you have to read it afterwards, so do what you like.
I understand all 3, so any developer can take over.

Slawek_Guzek · 2018-07-06

I'm personally using variant 4

IF SomeVeryVeryVeryLongFunctionName(ItemLedgerEntry."Posting Date", ItemLedgerEntry."Entry Type", 
  ItemLedgerEntry."Document Type", ItemLedgerEntry."SourceNo") 
THEN BEGIN
  DoSomething();
END;

or sometimes variant 5

WITH ItemLedgerEntry DO
  IF SomeVeryVeryVeryLongFunctionName("Posting Date", "Entry Type", 
    "Document Type", "SourceNo") 
  THEN BEGIN
    DoSomething();
  END;

The reason is to be able easilly see when the IF condition ends and the executed code begins, and also to have the IF/THEN BEGIN/END on the same indentation level, so going with cursor up/down one will arrive at beginnig/end of the block.

I'm folding the line with parameters when it is longer than approx 100 - 120 characters - this is to ensure that when I (or someone) will be merging the code in text editor the whole line fits in editor window when two editors (or a single window with two objects code) are positioned side-by-side

Juhl · 2018-07-06

You could look at NAV standard.
Variant 3 is the most used.

robbonick · 2018-07-06

Yeah I have looked in standard, and it varies between them all to be honest

Juhl · 2018-07-06

Variant 1 dosent make sense to me, but your right.
Try to look at new code. Ex. Codeunit 80 has been rewritten, and it uses variant 3.
NAV still contains old code.

But you have to read it afterwards, so do what you like.
I understand all 3, so any developer can take over.

Slawek_Guzek · 2018-07-06

I'm personally using variant 4

IF SomeVeryVeryVeryLongFunctionName(ItemLedgerEntry."Posting Date", ItemLedgerEntry."Entry Type", 
  ItemLedgerEntry."Document Type", ItemLedgerEntry."SourceNo") 
THEN BEGIN
  DoSomething();
END;

or sometimes variant 5

WITH ItemLedgerEntry DO
  IF SomeVeryVeryVeryLongFunctionName("Posting Date", "Entry Type", 
    "Document Type", "SourceNo") 
  THEN BEGIN
    DoSomething();
  END;

The reason is to be able easilly see when the IF condition ends and the executed code begins, and also to have the IF/THEN BEGIN/END on the same indentation level, so going with cursor up/down one will arrive at beginnig/end of the block.

I'm folding the line with parameters when it is longer than approx 100 - 120 characters - this is to ensure that when I (or someone) will be merging the code in text editor the whole line fits in editor window when two editors (or a single window with two objects code) are positioned side-by-side

Code Formatting - Functions with long Parameter Names, or many Parameters

Best Answers

Answers

Categories