1 / 13

Update on Conventions

Update on Conventions. Why (not) Using Conventions LabVIEW Style Guide CS Coding Conventions CS Color Schemes. conventions might contradict personal preferences "I use my own conventions" it is very hard to agree on and to accept common conventions

lamya
Download Presentation

Update on Conventions

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Update on Conventions Why (not) Using Conventions LabVIEW Style Guide CS Coding Conventions CS Color Schemes Dietrich Beck

  2. conventions might contradict personal preferences "I use my own conventions" it is very hard to agree on and to accept common conventions sticking to conventions slows down development checking conventions and "refactoring of code" takes time ... Why not Using Conventions Dietrich Beck

  3. ideal: everybody should stick to the same conventions code is easier to maintain others might be able to read your code reduce bugs improve re-usability save time (later!) avoid re-implementation of the same functionality (if code needs to be thrown away) ... of course: exceptions in specific cases Why Using Conventions? Dietrich Beck

  4. LabVIEW development guidelines: http://www.ni.com/pdf/manuals/321393d.pdf LabVIEW Style Checklist LabVIEW  Help  Search the LabVIEW Help ...  search for LabVIEW Style Checklist http://www.ni.com  search for LabVIEW Style Checklist  select LabVIEW version google for LabVIEW Style Checklist examples use and wire Error in and Error out wiring: from left to right, no hidden wires, no backward wires document code via descriptions of VIs, controls and indicators ... LabVIEW Style Guide Dietrich Beck

  5. LabVIEW  Tools  VI Analyzer. quotes from NI-Website "...Use the LabVIEW VI Analyzer Toolkit to improve code quality and catch potential problems earlier during development. The VI Analyzer automates code reviews and enables more exhaustive code analysis..." "... avoid overlooking improper coding techniques that could impact an application’s performance, functionality, or maintainability. Enforce good programming practices and coding styles within teams of developers in order to ensure the readability and functionality of code. Overall, use the VI Analyzer Toolkit regularly to develop high-quality, robust LabVIEW applications..." VI-Analyzer Dietrich Beck

  6. makes sense, if developer agree to coding conventions check VIs, using a prepared configuration file aim for less then  2% of failed tests improving VIs takes about one day per library  you might even find a few bugs  How to Use the VI Analyzer Dietrich Beck

  7. http://wiki.gsi.de/cgi-bin/view/CSframework/CsCodingConventionshttp://wiki.gsi.de/cgi-bin/view/CSframework/CsCodingConventions specific for CS framework depends on LabVIEW Style Guide (LSG) further refines LSG defines exceptions from LSG defines data types for communication some features might be checked using VI Analyzer some features require a real code review ... CS (Coding) Conventions Dietrich Beck

  8. common look and feel within an application indicate safety relevant information intuitively and unambiguously SCADA GUI Design and Colors red: danger yellow: warnin green: o.k. blue: you should do something Dietrich Beck

  9. example: PHELIX' "FiveColor.vi" defines colors for states user Interface DIN EN ISO 9241-110 SCADA: IEC/EN 60073 (VDE 0199), IEC/EN 60204-1 the above is not accessible via the web. Therefore: US Army TM 5-601: "SCADA Systems ..." http://www.army.mil/usapa/eng/DR_pubs/dr_a/pdf/tm5_601.pdf http://de.wikipedia.org/wiki/Mensch-Maschine-Schnittstelle ... color blind people: use rate of blinking fast: error/fatal slow: warning none: o.k. (more or less) problem: individual blink rate for indicators with LabVIEW SCADA GUI Design and Colors Dietrich Beck

  10. color of Boolean control/indicator background color text color (use with background color) text color (use with white background) Definition of Colors(by UtilityLib) Dietrich Beck

  11. need reference of control or indicator set status of value different VIs Boolean String or Numeric Listbox general: just set color of label and caption How to Use Dietrich Beck

  12. "UtilityLib.set color of panel to default.vi": Semi-Automated Coloring Dietrich Beck

  13. GUI Conventions... Dietrich Beck

More Related