This project has moved. For the latest updates, please go here.

SBDoc Comment Specification

Version 0.4b

SBDoc is a project for a tool to generate document from Small Basic source code, like JSDoc or CppDoc. SBDoc will parse keywords in comments in Small Basic source. Some of keywords are used in Program Database (this project).

Keywords

These keywords are case insensitive.

Version
Copyright
Repository
Challenge
Program ID
Last update
param
return

Document Comment

Document comments start with three single quotes.

Sample Comments

''' Program Database
''' Version 0.5b
''' Copyright © 2014-2015 Nonki Takahashi.  The MIT License.
''' Repository https://programdbsb.codeplex.com
''' Program ID HMK932
''' Last update 2015-12-14
Sub Compare
  ''' param text1, text2
  ''' return eq = "True" if text1 = text2
EndSub
Sub UnselectLine
  ''' param lOp - left operation "", "AND" or "OR"
  ''' param i - index of line array
  ''' return line[i] - "" if unselected
EndSub

Sample Output


.\ProgramDB.sb

Version 0.5b
Copyright © 2014-2015 Nonki Takahashi. The MIT License.
Repository https://programdbsb.codeplex.com
Program ID HMK932-1
Last update 2015-12-14

Main

Calls

  • Compare()
  • UnselectLine()

Subroutines Summary

subroutine description
Compare()
UnselectLine()

Subroutines Detail

Compare()

(description for Compare)

Parameters

text1
(description)
text2
(description)

Returns

eq
"True" if text1 = text2

UnselectLine()

(description for UnselectLine)

Parameters

lOp
left operation "", "AND" or "OR"
i
index of line array

Returns

line[i]
"" if unselected

Last edited Apr 17, 2016 at 2:42 PM by Nonki, version 9