devdocs.io: Alat dokumentasi pengaturcara, mengucapkan selamat tinggal kepada carian yang membosankan!

mata teras:

• devdocs.io adalah aplikasi web yang menyediakan akses cepat ke pelbagai bahasa depan dan manual rujukan perpustakaan. Antara muka adalah cekap dan pantas, dan ia mempunyai fungsi carian kabur masa nyata.
• Platform hanya mengintegrasikan kandungan rasmi, mengabaikan komen dan contoh yang dikemukakan pengguna. Ia adalah sumber terbuka dan menggalakkan sumbangan komuniti melalui GitHub. Pengguna juga boleh menggunakannya secara tempatan untuk memenuhi keperluan khusus, seperti API Sistem Dalaman Syarikat.
• devdocs.io dioptimumkan sepenuhnya untuk peranti mudah alih dan menyediakan pelbagai cara untuk memastikannya dikemas kini. Ia boleh dipasang sebagai plugin untuk teks dan kurungan yang luhur, serta enjin carian untuk Firefox dan Google Chrome. Ia juga menawarkan pelbagai pintasan papan kekunci intuitif untuk pengalaman pengguna yang lancar.

Adakah anda sering melalui proses pengekodan berikut?

1. memerlukan [memasukkan bahasa pengaturcaraan] definisi fungsi dan contoh.
2. Carian Google untuk fungsi ini.
3. Klik pada hasil pertama, jika anda tidak bernasib baik, ia adalah W3Schools, jika tidak, ia adalah manual dalam talian bahasa yang anda gunakan.
4. menyedari bahawa anda memerlukan demonstrasi dan penjelasan fungsi lain.
5. Kembali ke carian Google dan bukannya menggunakan carian di laman web bahasa, kerana ia tidak dapat diterangkan dan lebih perlahan daripada carian Google baru selepas memuatkan semula tab.
6. Ulangi langkah -langkah di atas.

Sebagai pemaju yang menggunakan banyak teknologi web, saya sering menghadapi keadaan ini. Ia telah menjadi lebih sukar daripada sebelumnya untuk mencari definisi teknikal fungsi atau kenyataan -bukan dari segi kerumitan, tetapi dari segi masa yang sia -sia. Bukankah lebih baik jika kita boleh mempunyai semua dokumen pembangunan di satu tempat, dalam antara muka yang dibolehkan akses luar biasa, dan mempunyai carian kabur yang sangat cepat untuk bahasa apa pun? Devdocs.io muncul.

Apa itu devdocs.io?

DevDocs adalah aplikasi web yang direka untuk memberi anda akses cepat kepada manual rujukan untuk hampir semua bahasa dan perpustakaan front-end. Ia menyenaraikan semua API dan dokumentasi rasmi mereka untuk bahasa terpilih yang diberikan, dengan mudah untuk melayari dan melihat format tanpa menu yang tidak perlu dan gaya cheesy yang laman web rasmi seperti Php.net cuba melaksanakan.

Ini adalah aplikasi web sumber terbuka yang dikuasakan oleh AJAX, dengan penonjolan sintaks, dan bahkan boleh digunakan sebagai lanjutan krom atau plug-in untuk teks atau kurungan luhur.

Apa yang boleh dilakukan oleh devdocs.io?

ia mengagregatkan manual rujukan untuk semua bahasa yang popular (dengan syarat manual mereka berada dalam format yang mudah diakses dan boleh dibaca mesin). Ia memberikan anda antara muka yang lancar dan cepat untuk mengaburkan carian dokumen dalam semua bahasa yang dipilih supaya anda dapat mencari maklumat yang anda perlukan dengan kunci yang paling rendah. Anda mungkin tertanya -tanya apa itu carian kabur? Carian Fuzzy adalah mencari rentetan yang kira -kira (tidak betul -betul) sepadan dengan apa yang anda masukkan. Editor seperti teks luhur dan LightTable Gunakan kaedah ini dalam tingkap carian arahan mereka - memasukkan sesuatu seperti "SA" akan memberi anda "Simpan sebagai .." kerana input sepadan dengan singkatan perintah. Memasuki "Delte" akan memberikan hasil yang mengandungi "Delta" dan "Padam", dan memasuki "BGCP" bahkan akan menyediakan "Klip Latar Belakang". Carian jenis ini membolehkan penalaan hasil yang sangat cepat, dan kerana ia adalah masa nyata, anda boleh mencampur dan memadankan dengan serta-merta.

Kandungan

Devdocs memuat turun indeks manual rujukan untuk bahasa pilihan anda, menyerapnya ke dalam cache tempatan anda, dan kemudian memberikan hasil daripadanya. Ini bermakna anda perlu memuat semula bahasa pilihan anda pada setiap mesin baru, tetapi cara ini melakukannya membawa peningkatan kelajuan yang lebih baik daripada kaedah Ajax lama yang menggunakan permintaan jauh. Nota - Pada masa ini, hanya indeks di luar talian dan hasil sebenar klik anda disediakan dari lokasi terpencil - sebagai contoh, walaupun ia di luar talian ia akan dipaparkan dalam hasil carian, anda masih memerlukan akses Internet untuk mendapatkan array JavaScript dokumentasi.

Adalah penting untuk diperhatikan bahawa kandungan yang diperoleh adalah terhad kepada kandungan rasmi. Ini bermakna bahawa penyertaan yang dikemukakan oleh pengguna (seperti komen dan contoh) akan diabaikan.

anda boleh menambah "php" sebelum pertanyaan carian dan tekan

tab

atau bar ruang (di mudah alih) ke julat bahasa tertentu (mis., PHP sahaja) dengan menambahkan "PHP "Sebelum pertanyaan carian dan menekan atau ruang angkasa

(di telefon bimbit) (sahaja).) Cari devdocs. Ini menukar mod carian ke "bahasa yang dipilih sahaja". Untuk keluar dari mod ini, hanya ruang belakang.

sumber terbuka dan penempatan tempatan

Devdocs adalah sumber terbuka dan menggalakkan masyarakat menyumbang dalam pelbagai cara. Pertama, ia terletak di GitHub dan menjemput pengguna untuk mengemukakan soalan dan memperbaiki kod, sama seperti mana -mana projek sumber terbuka yang baik. Kedua, Devdocs boleh dengan mudah digunakan secara tempatan, jadi anda boleh menjalankan atau menjadi tuan rumah versi anda sendiri. Sebagai contoh, menyesuaikannya ke API sistem dalaman syarikat sangat mudah. Akhir sekali, Devdocs menggunakan Trello untuk mengumpul maklum balas pengguna mengenai bahasa yang mereka mahu. Trello adalah senarai tugas berasaskan pasukan yang sangat cekap yang menyokong pelbagai papan maklumat di mana orang boleh bekerjasama, membincangkan dan mengundi (topik). Devdocs menggunakan kad ini untuk mengumpul undi untuk integrasi dalam setiap bahasa. Untuk mengambil bahagian, lihat di sini.

Devdocs dikekalkan dan dikemas kini secara berkala dan menawarkan pelbagai cara untuk bersaing dengan perubahan terkini:

Jika anda membukanya selepas tarikh kemas kini, laman web itu sendiri akan muncul dengan perubahan terkini.
Terdapat surat berita.
Mempunyai akaun Twitter.
Malah ada senarai mel.
Terdapat log perubahan terkini.

Semua ini seolah -olah datang dari sumber yang sama, jadi lebih baik untuk melanggan hanya satu daripada mereka.

Kelebihan lain

Devdocs dioptimumkan sepenuhnya untuk peranti mudah alih dan sangat responsif. Ia dibuka dengan cepat dan berfungsi dengan cara yang sama pada peranti mudah alih seperti yang dilakukan pada peranti desktop. Ia dibina dengan cara yang sesuai untuk laman web - pengalaman yang lancar, cepat dan konsisten pada setiap peranti. Thibaut Courouble melakukan pekerjaan yang hebat.

Seperti yang dinyatakan sebelum ini, aplikasi itu boleh dipasang sebagai plugin untuk teks dan kurungan yang luhur -yang bermaksud anda boleh mencari API yang diperlukan secara langsung dari editor. Lebih banyak plugin akan datang tidak lama lagi, dan yang paling ketara ialah plugin produk JetBrains. Aplikasi ini juga dipindahkan ke versi luar talian yang boleh dikonfigurasikan sifar yang tersendiri.

Devdocs boleh dipasang sebagai enjin carian untuk Firefox dan Google Chrome, serta pada dasarnya mana -mana pelayar dan aplikasi lain yang menyokong OpenSearch. OpenSearch adalah satu set piawaian yang membolehkan sumber mengenal pasti dirinya sebagai enjin carian.

juga menawarkan pelbagai pintasan papan kekunci, yang semuanya sangat intuitif dan sangat berguna, memberikan pengalaman yang benar -benar lancar.

Kesimpulan

Jika anda belum mendengar tentang Devdocs sebelum membaca artikel ini, saya sangat mengesyorkan anda mencubanya. Rangkaian ini sangat memerlukan sumber yang sangat mudah digunakan, jadi sila nasihatkan untuk membantu masyarakat mencari penyelesaian yang lebih baik untuk masalah yang mereka hadapi. Sekiranya anda dapat menyumbang, Devdocs berada di GitTip dan menyokong sumbangan PayPal - tetapi boleh dikatakan cara terbaik untuk membantu adalah menggunakannya, beritahu orang lain mengenainya, dan yang paling penting, dengan menyumbang kepada projek di GitHub memperbaikinya.

(Berikut adalah bahagian FAQ, yang telah ditulis semula dan diselaraskan mengikut teks asal, dan niat asal dikekalkan)

devdocs.io faq

Bagaimana devdocs.io berbeza dari platform dokumen lain?
• devdocs.io menonjol untuk kesederhanaan, cepat dan mesra pengguna. Ia mengintegrasikan pelbagai dokumen API dalam antara muka yang cepat, diperintahkan dan dicari. Tidak seperti platform lain, Devdocs.io membolehkan pengguna memuat turun dokumen untuk kegunaan luar talian, boleh diakses walaupun tanpa sambungan internet. Ia juga menyokong pintasan papan kekunci untuk navigasi mudah.

• Adakah devdocs.io percuma untuk digunakan? Ya, devdocs.io benar -benar bebas untuk digunakan. Ini adalah projek sumber terbuka, yang bermaksud ia bukan sahaja percuma, tetapi pengguna juga boleh mengambil bahagian dalam pembangunannya. Ini menjadikannya platform yang didorong oleh komuniti yang berkembang berdasarkan keperluan pengguna dan maklum balas.

• Bagaimana devdocs.io Memastikan ketepatan dokumentasinya? devdocs.io mengekstrak dokumennya secara langsung dari sumber rasmi, memastikan maklumat yang diberikan adalah tepat dan terkini. Platform ini juga membolehkan pengguna menyumbang pembetulan dan kemas kini untuk meningkatkan lagi ketepatan dokumen.

• Bolehkah saya menggunakan devdocs.io di luar talian? Ya, salah satu ciri utama Devdocs.io adalah keupayaannya untuk bekerja di luar talian. Pengguna boleh memuat turun dokumen yang mereka perlukan dan mengaksesnya pada bila -bila masa, di mana sahaja tanpa sambungan internet. Ini menjadikan Devdocs.io sumber yang boleh dipercayai, terutamanya bagi pemaju yang mungkin tidak dapat sentiasa menyambung ke Internet.

• Bagaimana untuk menyumbang kepada devdocs.io? Sebagai projek sumber terbuka, Devdocs.io mengalu -alukan sumbangan pengguna. Anda boleh menyumbang dengan melaporkan pepijat, membuat cadangan untuk penambahbaikan, dan juga menulis kod. Semua maklumat yang diperlukan untuk sumbangan boleh didapati di halaman GitHub Devdocs.io.

• devdocs.io menyokong peranti mudah alih? Ya, devdocs.io sepenuhnya responsif dan berfungsi dengan baik pada peranti mudah alih. Ini bermakna anda boleh mengakses dokumen yang diperlukan dari telefon pintar atau tablet anda, menjadikannya alat yang serba boleh untuk pemaju mudah alih.

• Berapa kerap dokumen dikemas kini di devdocs.io? devdocs.io berusaha untuk memastikan dokumentasinya terkini. Kekerapan kemas kini bergantung kepada sumber dokumen. Sebagai contoh, jika dokumentasi rasmi dikemas kini, Devdocs.io akan mencerminkan perubahan ini secepat mungkin.

• Bolehkah saya menyesuaikan antara muka devdocs.io? Ya, Devdocs.io membolehkan pengguna menyesuaikan antara muka mengikut keutamaan mereka. Anda boleh memilih dokumen mana yang ingin anda paparkan, menyesuaikan susun atur, dan beralih antara tema cahaya dan gelap.

• Adakah devdocs.io menyokong semua bahasa pengaturcaraan? devdocs.io menyokong pelbagai bahasa dan teknologi pengaturcaraan, tetapi ia mungkin tidak meliputi semua bahasa. Platform ini memberi tumpuan kepada bahasa dan teknologi yang paling biasa digunakan dalam industri.

• Pengguna Devdocs.io mempunyai komuniti atau forum? Walaupun devdocs.io tidak mempunyai komuniti atau forum yang berdedikasi, pengguna boleh berinteraksi dan menyumbang melalui halaman GitHub platform. Di sini mereka boleh melaporkan isu, membuat cadangan untuk penambahbaikan, dan berbincang dengan pengguna dan penyumbang lain.

Semua pautan imej dibiarkan seperti.

Atas ialah kandungan terperinci Melihat devdocs.io. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!