Hvordan dokumenterer man sin kode med built-in tools i LabVIEW?

Hvordan dokumenterer man sin kode med built-in tools i LabVIEW?

Software

Brug en type def. cluster og en single feedback node, tjek betingelserne en enkelt gang fra sidste iteration, og skriv kun til den enkelte værdi, når det er nødvendigt, med henblik på at skabe mere overskuelighed. Få flere tips til dokumentation i LabVIEW i blogindlægget. 


Klik her for at se billedet i fuld størrelse.

Alle har utvivlsomt stødt på udokumenteret kode på et tidspunkt, ligesom den der er vist i toppen af billedet, og stillet sig selv spørgsmål som:

  • Hvorfor er denne kode skrevet?
  • Hvad er betingelserne for udførelsen?
  • Hvorfor er betingelserne for casestrukturerne afhængige af VI’ens output?
  • Hvorfor er dette output inverteret?

Ovenstående spørgsmål kunne imidlertid have været undgået, hvis man havde gjort en lille indsats ved at dokumentere koden vha. de indbyggede værktøjer i LabVIEW.

På nederste del af billedet har jeg opsat nogle pointer i forbindelse med, hvordan man dokumenterer en VI ved at gøre brug af det mest simple værktøj i LabVIEW. Jeg har brugt Cluster datatype sammen med en feedback node til at håndtere dataene i hver iteration, da disse giver god dokumentation af den tilgængelige data. Og ved at tilføje labels og sub-diagram labels for casestrukturerne bliver forståelsen for udførelsesprocessen meget tydeligere.

En væsentlig pointe at nævne er desuden, at disse værktøjer er tilgængelige i alle versioner af LabVIEW.

Bliv klogere på LabVIEW

Start med at dokumentere din kode i dag!

Min intention med at skrive dette blogindlæg var at fremhæve vigtigheden af dokumentation med henblik på at reducere kompleksiteten for læseren samt at reducere fejl i koden i fremtiden.

Læs også: “Bliv en bedre LabVIEW-udvikler [Download gratis prøveversioner]”.

Relaterede indlæg

Følg os på LinkedIn

LinkedIn Følg os

Mest populære indlæg

Seneste nyt

Modtag vores nyheder