Code Window: Difference between revisions

From NSB App Studio
Jump to navigation Jump to search
No edit summary
 
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[file:3.8.jpg]] <br />
[[File:codewindow.png|frame|An autocomplete box appears if needed.]]
The Code Window is used the edit the code in your program. You can put all your code in a single block, or have a separate code block for each form as well as a global section. At runtime, they are treated as a single block, so be careful not to redefine functions or variables. <br />
[[File:codewindow1.png|frame|Right click to see these options.]]
Statements can be made longer than one line by using a space and a “_” character at the end of a line. <br />
[[File:codewindow2.png|frame|Click to go directly to a function.]]
Cut, Paste, Delete and other similar functions can be used from the Menu, the Toolbar or the keyboard. <br />
 
The dropdown bar at the top of the screen can be used to go directly to a Function or to a line number. <br />
The Code Window is used the edit the code in your program.  
To view the JavaScript translation of the code, type Ctrl-J for the whole program or a selection.
 
*You can put all your code in a single block, or have a separate code block for each form as well as a global section. At runtime, they are treated as a single block, so be careful not to redefine functions or variables.
 
*Code can be in JavaScript, BASIC or other language, depending on the setting in [[New Project Dialog|New Project,]] [[Properties Window|Form or Code Module]] properties.
 
== Features ==
 
=== Editing ===
 
* In BASIC, statements can be made longer than one line by using a space and a “_” character at the end of a line.  
 
* Syntax checking is done as each BASIC line is completed.  If there is a syntax error, the line gets a red underline. If you hover over it, you can see the full error message.
 
* Cut, Paste, Delete and other similar functions can be used from the Menu, the Toolbar or the keyboard.  
 
* Line numbers may be up to 99999.
 
* Format Code cleans up the formatting of BASIC code, normalizing all the indents.
 
=== Moving Around ===
 
* The dropdown bar at the top of the screen can be used to go directly to a Sub, Function or line number.
 
* Code Folding makes it easier to look at just the code you are interested in. Click on the minus sign to the left of a code block to collapse it.
 
* To go directly to a function in your program, select the name of the function elsewhere in your code, right click and select "Go to function definition."
 
* If you have gone directly to a function, the 'Return' option will take you back.
 
=== Translation ===
 
* If you are working in a language other than JavaScript, you may view the translation of the code. Do a right click and select "View JavaScript". You can do this for the whole module or just a selection.
 
=== AI Coding Assistant ===
[[File:chatgpt.png|none]]
* Click on this icon to bring up the [[AI Coding Assistant]].
 
=== Style Checking with ESLint ===
[[File:eslint.png|none]]
* If you're using JavaScript, the option "Check Syntax using Eslint" will appear. The module will be checked for proper style using eslint. The [https://github.com/airbnb/javascript AirBNB Style Guide] is used. A dialog box listing any errors or warnings will be displayed. You can also click on the Eslint icon in the tab bar.
 
=== Inserting Code ===
 
* To insert code from an external file, drag and drop the file from the Finder into the Code Window.
 
* The code will be inserted into your app at the current position, just as if you had typed it in.
 
* You can insert code from .txt, .cod, .bas or .js files.
 
=== Help ===
 
* To bring up the Wiki page for a keyword, select the word, right click and select "Open Wiki Page".
* Where possible, hints will appear for objects when you enter the period.
* Where possible, tips will appear for functions when you enter the open parenthesis. (Note: does not currently work on Mac).
 


Next: [[Deploy_Options|Deploy Options]]
Next: [[Deploy_Options|Deploy Options]]

Latest revision as of 19:46, 15 December 2023

An autocomplete box appears if needed.
Right click to see these options.
Click to go directly to a function.

The Code Window is used the edit the code in your program.

  • You can put all your code in a single block, or have a separate code block for each form as well as a global section. At runtime, they are treated as a single block, so be careful not to redefine functions or variables.

Features

Editing

  • In BASIC, statements can be made longer than one line by using a space and a “_” character at the end of a line.
  • Syntax checking is done as each BASIC line is completed. If there is a syntax error, the line gets a red underline. If you hover over it, you can see the full error message.
  • Cut, Paste, Delete and other similar functions can be used from the Menu, the Toolbar or the keyboard.
  • Line numbers may be up to 99999.
  • Format Code cleans up the formatting of BASIC code, normalizing all the indents.

Moving Around

  • The dropdown bar at the top of the screen can be used to go directly to a Sub, Function or line number.
  • Code Folding makes it easier to look at just the code you are interested in. Click on the minus sign to the left of a code block to collapse it.
  • To go directly to a function in your program, select the name of the function elsewhere in your code, right click and select "Go to function definition."
  • If you have gone directly to a function, the 'Return' option will take you back.

Translation

  • If you are working in a language other than JavaScript, you may view the translation of the code. Do a right click and select "View JavaScript". You can do this for the whole module or just a selection.

AI Coding Assistant

Style Checking with ESLint

  • If you're using JavaScript, the option "Check Syntax using Eslint" will appear. The module will be checked for proper style using eslint. The AirBNB Style Guide is used. A dialog box listing any errors or warnings will be displayed. You can also click on the Eslint icon in the tab bar.

Inserting Code

  • To insert code from an external file, drag and drop the file from the Finder into the Code Window.
  • The code will be inserted into your app at the current position, just as if you had typed it in.
  • You can insert code from .txt, .cod, .bas or .js files.

Help

  • To bring up the Wiki page for a keyword, select the word, right click and select "Open Wiki Page".
  • Where possible, hints will appear for objects when you enter the period.
  • Where possible, tips will appear for functions when you enter the open parenthesis. (Note: does not currently work on Mac).


Next: Deploy Options