Слияние кода завершено, страница обновится автоматически
Это руководство по написанию документации для Electron.
# в начале.##.# в заголовке в соответствии с их глубиной вложенности.Пример с использованием Quick Start:
# Quick Start
...
## Main Process
...
## Renderer Process
...
## Run Your App
...
### Run as a Distribution
...
### Manually Downloaded Electron Binary
...
Для справочных материалов по API существуют исключения к этому правилу.
bash вместо cmd в блоках кода (из-за синтаксического выделения).js и javascript проверяются с помощью
standard-markdown.Следующие правила применяются только к документации API.
Каждая страница должна использовать фактическое имя объекта, возвращаемого require('electron'), как заголовок, например BrowserWindow, autoUpdater, и session.```markdown
Управление браузерными сессиями, куками, кэшем, настройками прокси и т.д.
Для модулей, которые не являются классами, их методы и события должны быть перечислены под заголовками ## Methods и ## Events.
Пример с использованием autoUpdater:
# autoUpdater
## Events
### Event: 'error'
## Methods
### `autoUpdater.setFeedURL(url[, requestHeaders])`
`## Класс: TheClassName`.
* Одна страница может содержать несколько классов.
* Конструкторы должны быть перечислены с помощью заголовков уровня `###`.
* [Статические методы](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/static) должны быть перечислены под заголовком `### Статические методы`.
* [Методы экземпляра](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#Prototype_methods) должны быть перечислены под заголовком `### Методы экземпляра`.
* Все методы, которые имеют возвращаемое значение, должны начинаться с описания вида "Возвращает `[ТИП]` - Описание возвращаемого значения"
* Если метод возвращает `Объект`, его структура может быть указана с помощью двоеточия, за которым следует новая строка, а затем ненумерованный список свойств в том же стиле, что и параметры функции.
* События экземпляра должны быть перечислены под заголовком `### События экземпляра`.
* Свойства экземпляра должны быть перечислены под заголовком `### Свойства экземпляра`.
* Свойства экземпляра должны начинаться с "A [Тип свойства]..." Используя классы `Session` и `Cookies` в качестве примера:```markdown
# session
## Методы
### `session.fromPartition(partition)`
* `partition` String - Идентификатор раздела.
## Свойства
### `session.defaultSession`
## Класс: Session
### События экземпляра
#### Событие: 'will-download'
### Методы экземпляра
#### `ses.getCacheSize(callback)`
* `callback` Function - Функция обратного вызова, которая получает размер кеша.
### Свойства экземпляра
#### `ses.cookies`
## Класс: Cookies
### Методы экземпляра
#### `cookies.get(filter, callback)`
* `filter` Object - Фильтр для получения куки.
* `callback` Function (опционально) - Функция обратного вызова, которая получает результат.
```* [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
* [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
* [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
* [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
* [`Boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
* Или пользовательским типом, таким как тип Electron's [`WebContents`](api/web-contents.md)Если аргумент или метод уникален для определенных платформ, эти платформы обозначаются через пробелы и курсивом после типа данных. Значения могут быть `macOS`, `Windows` или `Linux`.
```markdown
* `animate` Boolean (опционально) _macOS_ _Windows_ - Анимировать объект.
Array тип аргументов должен указывать, какие элементы массив может включать в описании ниже.
Описание для аргументов типа Function должно быть ясным в отношении того, как его можно вызвать, и перечислять типы параметров, которые будут переданы ему.
Раздел о событиях должен быть в следующем формате:
### Событие: 'wake-up'
Возвращает:
* `time` String
...
Заголовок может быть на уровне ### или #### в зависимости от того, является ли это событие модуля или класса.
Аргументы событий следуют тем же правилам, что и методы.
Раздел о свойствах должен быть в следующем формате:
### session.defaultSession
...
Заголовок может быть на уровне ### или #### в зависимости от того, является ли это свойство модуля или класса.
Переводы документации Electron расположены в директории docs-translations.
Чтобы добавить еще один набор (или частичный набор):* Создайте поддиректорию, названную сокращением языка.
README.md в вашей языковой директории, чтобы добавить ссылки на переведенные файлы.README Electron
README.Обратите внимание, что файлы в директории docs-translations должны содержать только переведённые версии, оригинальные английские файлы не должны копироваться туда.Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )