Skip to content
Priyan Vaithilingam edited this page Nov 24, 2017 · 9 revisions

Welcome

Code Talk is a step to make programming IDEs more accessible. The plugin currently concentrates on three main aspects of Programming:

  1. Glanceability
  2. Real-Time Error information
  3. Accessible Debugging

CodeTalk is currently only available for Visual Studio running in windows. We are working very hard towards bringing it to more platforms and IDEs. Stay tuned.

Contribute

Please visit the Contribution page.

Features

Glanceability

These features help the user to glance through the code. These features require a set of key combinations, as mentioned in the feature explanation.

Functions List (CTRL + ~ , CTRL + F)

Invoking this option shows a list of all the methods in the current active code file. The user can then search for a function by typing the first few characters of the function name and the relevant ListItem is selected. the user can go to the selected function by pressing enter on the selected ListItem when it is in focus.

File Summary (CTRL + ~ , CTRL + M)

Invoking this option shows the summary of the current active code file. This is a tree view containing all the namespace, class, functions etc. Pressing enter on the selected item will take you to the start of respective block.

Current Context (CTRL + ~ , CTRL + G)

Invoking this option shows the context of the current cursor position in the current active code file. This is a list view containing all the ancestors of the current block in the code file. For example if the cursor is inside a function this will list the function, class in which the function is present, and the namespace of the class etc. Pressing enter on the selected item will take you to the start of respective block.

Move to Parent (CTRL + ~ , CTRL + J)

Invoking this option will move the cursor position to the start of the parent block. For example, if the current cursor is inside a function, this will move the cursor to the class in which it is present. If the curosr is inside class, the cursor is moved to namespace etc.

Skip Comment (CTRL + ~ , CTRL + C)

Invoking this option will skip the XML summary comment for the current block if the cursor position is inside the comment. Else no action is taken.

Real-Time Error Information

These features help user to detect and correct errors easily.

Errors (CTRL + ~ , CTRL + E)

Invoking this will give you a list of all the syntax errors in the current active code file. Pressing enter in the selected item will take you to the line where the respective error had occcured.

Automatic Error Detection

Code talk automatically checks for syntax errors from time to time and will proactively alert the user with a mild tone in the background. The user can then know error information using the previous functionality.

Talkpoints

Talkpoints are a unique and new way to debugging in visual studio. Talkpoints are audio breakpoints which are accessible and simple to use. There are three types of Talkpoints:

  • Tonal Talkpoints : Tonal talkpoints are breakpoints which will play a sound tone when hit. User can choose from a list of included tones in the app. External tones will be supported soon.

  • Textual Talkpoints : Textual talkpoints are breakpoints which can speak a text out when the breakpoint is hit. The user can give any string for code talk to speak.

  • Expression Talkpoints : Expression talkpoints are breakpoints which can evaluate an expression and speak the result out. The user should give any expression valid in the block and the result will be spoken when the breakpoint is hit.

Adding a Talkpoint (CTRL + ~ , CTRL + B)

To add a talkpoint, press CTRL + ~ , CTRL + B and choose the type of talkpoint from the talkpoint window. In case of tonal talkpoint choose the tone and in case of textual or expression talkpoint enter the statement or expression respectively. The continue breakpoint checkbox, if enabled, will not break when the talkpoint is hit and the execution resumes after audio. If unchecked, the execution breaks. Clicking the add talkpoint button will add the talkpoint to the code.

Note : Currently only one talkpoint is supported per line. Multiple talkpoints per line is coming soon.


Clone this wiki locally