This small ASNA Visual RPG Windows project shows a way to build a simple Data File Utility (DFU)-like program with AVR. This is a very simple project and a good one for first-time AVR coders to spend time with.

Full project on GitHub

Download project zip file from GitHub

See fully annotated source code

 

Figure 1a. Enter a customer number

 

Figure 1b. Update customer information

 

A bonus for the adventurous coder

The text above includes a link to this project's annotated source code (here is that link again). That annotated code is created directly from the project's source code with an open-source Python-based tool called Pycco.

Pycco is one of many projects derived from the JavaScript-based Docco project which generates documentation (annotated code, really) from source. Pycco is Docco written in Python.

Using Pycco, this source code:

    // ### Copy fields from inputs fields to record format fields
    BegSr PopulateRecordFromUI
        Cust_CMName     = txtCMName.Text.Trim()
        Cust_CMAddr1    = txtCMAddr1.Text.Trim()
        Cust_CMCity     = txtCMCity.Text.Trim()
        Cust_CMState    = txtCMState.Text.Trim()
        Cust_CMPostCode = txtCMPostCode.Text.Trim()
        // CMFax is numeric so RemoveNonNumericCharacters removes
        // any non-numeric characters before saving the value
        Cust_CMFax      = RemoveNonNumericCharacters(txtCMFax.Text)
        Cust_CMPhone    = txtCMPhone.Text.Trim()
    EndSr

 

Produced this portion of the annotated code:

 

Pycco reads your source and uses its comments to generate the annotations. Comments can be formatted with Markdown. For example, this line of code

    // ### Copy fields from inputs fields to record format fields

translates to an H3 tag in the code annotation (in Markdown, "###" translates to the H3 tag):

    <h3>Copy fields from inputs fields to record format fields</h3>

You can read more about Markdown syntax here. Visual Studio Code has great Markdown support--I use it and Markdown for virtually all of the writing I do. As you read the raw code here you'll notice that Markdown has a simple syntax for inserting things such as images and links.

You need to have Python and Pycco installed on your PC. See python.org for how to get and install Python (it's free). Instructions for installing custom modules (such as Pycco) are here. (An older version of Python may already be present on your Windows PC. If so, you could try using it--but generally, it's better to install Python 3.9x).

To annotate one of your projects, copy the Pycco folder from this project (use the download zip file link near the top of the article) into the root of your AVR project. Then from the pycco folder run the annotate-code.bat batch file from a command line. That command produces a pycco-docs folder with your source code annotated in HTML files. A top-level directory of source members (with your folder structure preserved) is in the file named master_index.html.

The run-pycco.py Python script in the pycco directory does the work of annotating your source.

Near the end of that script you'll see these two lines:

        cmd = f'pycco {file} -d ./pycco-docs -l javascript -p'
        os.system(cmd)

This Python code results in the command line:

       pycco {file} -d ./pycco-docs -l javascript -p'

being run for each file in your project (where {file} is the name of a source member in your project). This line calls Pycco for each project member and is what generates its annotated HTML file.  Pycco supports many languages, but unfortunately, it doesn't support AVR directly. However, AVR comment rules match JavaScript's so the -l flag tells Pycco to use JavaScript commenting rules.

To determine the files for Pycco to process, the run-pycco.py script uses this Python structure (formally, it's a Python tuple):

    searches = ('global.asax', 'web.config', '*.aspx', '**/*.aspx', '*.vr', '**/*.vr', 'app_code/*.vr' )

This structure names either specific files or directories. For example, the '**/*.vr' syntax includes any files with a .vr extension in any folder.

Another tuple specifies found files to exclude:

    ignored_files = ('^.*designer.vr', '^.*assemblyinfo.vr')       

This tuple causes any file ending in either designer.vr or assemblyinfo.vr to be excluded.

I tweaked the Pycco CSS a little to get the green and blue bars on the annotation.

I'm not a fan of overly commented code and Pycco comments certainly fall into that category. However, there may be merit in a team following some good coding conventions and making their annotated code available--and Pycco is great for published, teaching-style code.

It's beyond the scope of this article, but to make the Pycco-generated annotated pages available on the Web, I'm using a cool feature of GitHub called GitHub Pages to provide what is essentially a static site host for HTML pages. With just a batch file I can commit project changes to Git, generate the Pycco files, and then push both the project and Pycco changes up to GitHub. GitHub is truly one of the modern wonders of the world!

I know this Pycco section is out in the weeds for many of you, but thought I would include it for the curious (and I got tired of trying to find the last project for which I did this and figuring out how to do it again. Now I have a little documentation.)