SBDoc Comment Specification

SBDoc Comment Specification

Version 0.5.05

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.

Keywords

These keywords are case insensitive.

Version
Copyright
Repository
Challenge
Program ID
Last update
param
return

Sample Comments

' Program Database
' Version 0.7b
' Copyright © 2014-2017 Nonki Takahashi.  The MIT License.
' Repository https://github.com/nonkit/ProgramDB
' Program ID HMK932-2
' Last update 2017-05-20

Sub Compare
  ' Compare numbers or texts
  ' param text1, text2
  ' return eq = "True" if text1 = text2
EndSub

Sub UnselectLine
  ' Unselect line
  ' param lOp - left operation "", "AND" or "OR"
  ' param i - index of line array
  ' return line[i](i) - "" if unselected
EndSub

Credits

IntellisenseSubroutine.png (telephone icon)
Copyright © 2008-2015 Microsoft Corporation.  All rights reserved.
See more details.

Sample Output

---

.\ProgramDB.sb

Program Information

Title	Program Database
Version	0.7b
Copyright	© 2014-2017 Nonki Takahashi. The MIT License.
Repository	https://github.com/nonkit/ProgramDB
Program ID	HMK932-2
Last update	2017-05-21

Subroutines

subroutine	description
Compare()	Compare numbers or texts
UnselectLine()	Unselect line

Compare()

Compare numbers or texts

Parameters

text1
(description)

text2
(description)

Returns

eq
"True" if text1 = text2

---

UnselectLine()

Unselect line

Parameters

lOp
left operation "", "AND" or "OR"

i
index of line array

Returns

line[i]
"" if unselected

---