Skip to content

Commit a731728

Browse files
committed
Документировал IHostApplication
1 parent 6ac9e8c commit a731728

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

src/ScriptEngine.HostedScript/IHostApplication.cs

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,36 @@ This Source Code Form is subject to the terms of the
99

1010
namespace ScriptEngine.HostedScript
1111
{
12+
/// <summary>
13+
/// Интерфейс взаимодействия с приложением, которое хостит движок скрипта.
14+
/// Хост-приложение может быть не консольным, а 3D-игрой или GUI-окном, поэтому движок не знает
15+
/// куда выводить текст в каждом конкретном случае. Это определяет реализация IHostApplication.
16+
/// </summary>
1217
public interface IHostApplication
1318
{
14-
void Echo(string str, MessageStatusEnum status = MessageStatusEnum.Ordinary);
15-
void ShowExceptionInfo(Exception exc);
19+
/// <summary>
20+
/// Вывод пользовательских сообщений методом Сообщить.
21+
/// </summary>
22+
/// <param name="str">Строка</param>
23+
/// <param name="status">Статус сообщения (второй параметр метода Сообщить)</param>
24+
void Echo(string str, MessageStatusEnum status = MessageStatusEnum.Ordinary);
25+
26+
/// <summary>
27+
/// Показать информацию о неперехваченном исключении.
28+
/// </summary>
29+
/// <param name="exc">Неперехваченное исключение</param>
30+
void ShowExceptionInfo(Exception exc);
31+
32+
/// <summary>
33+
/// Ввод данных методом ВвестиСтроку. Хост должен предоставить средства ввода текста.
34+
/// </summary>
1635
bool InputString(out string result, string prompt, int maxLen, bool multiline);
36+
37+
/// <summary>
38+
/// Аргументы командной строки, доступные скрипту в коллекции АргументыКоманднойСтроки.
39+
/// Хост может при запуске получать собственные аргументы, которые не нужны или не должны быть видны в скриптах,
40+
/// поэтому хост может отфильтровать строку запуска и предоставить скрипту только аргументы непосредственно скрипта.
41+
/// </summary>
1742
string[] GetCommandLineArguments();
1843
}
1944
}

0 commit comments

Comments
 (0)