Официальная документация по разработке PhalApi

Этот документ предназначен для разработчиков, впервые работающих с PhalApi. Его цель — объяснить, как использовать PhalApi для быстрой разработки. Документ должен быть кратким и понятным, а также сопровождаться примерами.

Правила написания документа

Чтобы предоставить разработчикам краткие, понятные и полезные технические документы, мы договорились о следующем:

1. Имя файла

Используйте английские слова в именах файлов, разделяя их дефисом. Не нужно нумеровать файлы, и не рекомендуется использовать китайские иероглифы, чтобы избежать трудночитаемых и длинных URL-адресов. Например:

# Неправильное имя файла
[1.1]-下载与安装.md

# Рекомендуемое имя файла
setup.md

2. Шаблон документа

============================================

Заголовок первого уровня, заголовок раздела

Заголовок второго уровня, подзаголовок

Заголовок третьего уровня, список содержимого

Заголовок четвёртого уровня, старайтесь избегать использования

Примечание: некоторые замечания, советы, ссылки для участия.

Можно выделить ключевые слова жирным шрифтом.

============================================

3. Стиль кода

Для фрагментов кода укажите язык программирования, чтобы можно было выделить код. Например:

```php
<?php
// Ниже приведён фрагмент кода на php...

Пример:

<?php
$api = new PhalApi();
$rs = $api->response();
$rs->output();

Если необходимо указать путь к файлу кода, можно добавить комментарий в первой строке, например:

<?php
// Входной файл ./Public/index.php 
$api = new PhalApi();
$rs = $api->response();
$rs->output();

4. Файлы изображений

Храните изображения на CDN, чтобы обеспечить быстрый доступ и просмотр. Используйте самостоятельную загрузку изображений на CDN Qiniu.

5. Старайтесь использовать короткие предложения

Неправильный способ написания:

Это предложение очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень длинное.  

Рекомендуемый способ написания:

Это очень длинное предложение, потому что оно действительно очень длинное.  

6. Знаки препинания в основном тексте должны быть китайскими полными символами, а не английскими половинными символами

Неверный способ написания:

Здесь последняя запятая — это английская половинка, а восклицательный знак — тоже английская половинка!

Рекомендуемый способ написания:

Здесь последняя запятая — китайская полная, а восклицательный знак — китайский полный!