Фрагменты программы

Иногда в ПЗ включают отрывки программ, фрагменты файлов, консольные команды и т.д. В таких случаях рекомендуется выносить их на отдельные (пронумерованные) строки, начиная с отступа, равного отступу для абзацев, и формировать структуру кода при помощи табуляций и пустых строк.

Если в тексте приводится несколько фрагментов программного кода, то им присваивают заголовки. Заголовок листинга выравнивают по левому краю, например:

Листинг 1 – Открытие ADO-соединения с использованием Microsoft OLE DB Provider for ODBC (c DSN)

1: Dim cn As ADODB.Connection

2: Dim rs As ADODB.Recordset

3:

4: Function ADODB_ConnectedODBC() As Boolean

5: 'устанавливает cоединение для ODBC

6:

7:

8: On Error GoTo err_not_connection

9:

10: Set cn=New ADODB.Connection

11: cn.Provider = "MSDASQL"

12: cn.ConnectionString="DSN=Test_SQL_Server; &_

13: UID=Test_User; PWD=test"

14: cn.Open

15: ADODB_ConnectedODBC=True

16: Exit Function

17:

18: err_not_connection:

19: MsgBox Err.Description

20: ADODB_ConnectedODBC=False

21:

22: End Function

23:

24: Sub Test_ADODB_Connected()

25: 'тестирует ADODB_Connected: устанавливает соединение

26: 'и использует данные из таблицы Товары

27:

28: If ADODB_ConnectedSQL() Then

29: MsgBox "Похоже, соединение установлено"

30: 'код, использующий установленное соединение:

31:

32: Set rs=New ADODB.Recordset

33: rs.CursorType=adOpenDynamic

34: rs.Source="SELECT * FROM Товары"

35: Set rs.ActiveConnection=cn

36: rs.Open

37:

38: MsgBox rs.Fields(1) & " " &_

39: rs.Fields(1).Name & " " & rs.Fields(1).Type

40:

41: cn.Close 'закрыть соединение

42: Else

43: MsgBox "Что-то не сложилось!"

44: End If

45:

46: End Sub

Листинги, за исключением листингов приведенных в приложениях, нумеруют арабскими цифрами сквозной нумерацией в пределах всей записки или раздела. В случае нумерации в пределах раздела номер листинга состоит из номера раздела и порядкового номера листинга, разделенных точкой. Не допускается сквозная нумерация в пределах подразделов и пунктов.

Листинги каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе один листинг, он должна быть обозначен «Листинг 1» или «Листинг В.1» (единственный листинг в приложении В).

На все листинги документа должны быть приведены ссылки в тексте документа. При ссылке следует писать слово «листинг» полностью, с указанием его номера, например, «… приведены в листинге 1».

При переносе части листинга на другие страницы название помещают только над первой частью.

Кроме того, листинги, названия команд, пунктов меню, клавиш ит.п., рекомендуется использовать шрифт CourierNew.

Дата добавления: 2015-08-27