Documentation question (1 Viewer)

[Seraph]

Hey ppl i have a question ..

Is Intristic and Internal Documentation the same thing? they dont even have the word Intristic in my textbook and im just curious

Because if i rememeber correctly isnt Intristic JUST the meaningful varialbe names

where as Internal documentation includes comments and remarks as well as Intristic documentation?

 

[Winston]

Yes that's it Internal is comments, whereby Intrinsic is meaningful variables, and good indentation of code, and the way code is structured to be really pleasing to read.

 

[jason120au]

For example below is good intrensic documentation

Begin 'module works the GST of the amount entered'
get amount
Index = index +1
While Index > 0 Then
amount = amount * 0.10
End While
Display amount

Bad documentation

Begin get amount index = 0 While Index > 0 Then amount = amount * 0.10 End While Display Amount

 

[Winston]

Originally posted by jason120au
For example below is good intrensic documentation

Begin 'module works the GST of the amount entered'
get amount
Index = index +1
While Index > 0 Then
amount = amount * 0.10
End While
Display amount

Bad documentation

Begin get amount index = 0 While Index > 0 Then amount = amount * 0.10 End While Display Amount

lol not really bad indenting there mate, and you should make the core keywords in capitals or bold

[B] BEGIN[/B] GSTModule

[B] GET[/B] amount
 Index = Index + 1

      [B]WHILE[/B] Index > 0 

             amount = amount * 0.10

      [B]END WHILE [/B]

[B] PRINT [/B]amount

[B] END [/B]GSTModule

 

[jason120au]

yeah yeah yeah, I haven't done algorithms for close to 6 months

 

[Seraph]

okay , thank you !!