Kadang-kadang ketika mengetik sesuatu yang berhubungan dengan bahasa pemrograman case-sensitive saya akhirnya memulai kalimat dengan nama fungsi. Sekarang aturan bahasa Inggris menyatakan bahwa kata pertama dalam sebuah kalimat perlu ditulis dengan huruf besar; nama fungsinya adalah huruf kecil. Jika Anda bertanya-tanya apa yang bisa saya katakan yang akan menghasilkan kata pertama menjadi nama fungsi, ambil contoh ini:
Implementasi ketakutan Anda rusak. fread perlu mengembalikan jumlah byte yang dibaca.
Saya mengerti bahwa saya bisa mengubah contoh ketakutan yang kedua menjadi Ini, tetapi saya ingin tahu cara terbaik untuk menangani ini selain hanya menulis ulang kalimat itu. Haruskah saya menggunakan nama fungsi untuk huruf besar? Satu-satunya cara saya ingin mendengar "menulis ulang kalimat" sebagai jawaban adalah jika memulai kalimat dengan nama fungsi melanggar beberapa aturan bahasa Inggris yang tidak saya sadari. Sunting: Saya sangat berterima kasih kepada semua orang atas jawaban ini. Mereka telah mengubah dan meningkatkan wawasan saya tentang masalah ini. Saya telah belajar cukup banyak dari ini. Saya sangat terkejut bahwa saya tidak memikirkan solusi sederhana namun bagus ini.
Saya pikir pendapat saya tentang berganti-ganti kalimat itu terlalu sulit dan sekarang saya menyadari karena jawaban yang baik ini bahwa secara keseluruhan mengubah kalimat tampaknya menjadi pilihan terbaik untuk menangani kasus-kasus ini baik itu menambahkan tanda kurung setelah fungsi atau mengatakan Fungsi sebelum nama fungsi dan jika tersedia menggunakan format untuk nama fungsi.
Jawaban:
Dalam tipografi, ini biasanya ditangani dengan menggunakan render yang berbeda, apakah itu awal kalimat atau tidak, untuk menunjukkan bahwa apa yang mengenai mata bukan hanya sebuah kata dalam kalimat tetapi entitas khusus.
freadImplementasi Anda rusak.freadperlu mengembalikan berapa byte yang dibaca.Bergantung pada seberapa formal suatu dokumen, dokumen itu dapat mengadopsi pendekatan yang sama. Bagaimanapun hal itu menghilangkan masalah yang Anda identifikasi, jadi Anda mungkin ingin menggunakannya untuk alasan itu saja.
Dalam dunia teks biasa (seperti dicatat oleh beberapa komentar dan jawaban lain), menambahkan tanda kurung ke nama fungsi sedikit membantu, tetapi karena kita juga perlu merujuk ke entitas yang tidak menggunakan tanda kurung, ini hanya memiliki nilai terbatas. Secara umum, singkat mengadopsi konvensi seputar teks dengan karakter khusus seperti tanda kurung dan tanda bintang, di dunia teks biasa ada sedikit pilihan selain menghindari masalah dengan merestrukturisasi kalimat.
sumber
freadbukan sebuah kata; itu adalah simbol yang mewakili suatu entitas. Itu tidak tunduk pada tata bahasa.()atau(...)untuk menunjukkan itu fungsi. Tapi itu tidak selalu berhasil, terutama ketika berhadapan dengan variabel dan semacamnya. Apa yang saya lakukan adalah membungkus nama dengan`(centang karakter) untuk menunjukkan kode itu.Jika ada persyaratan mutlak untuk memulai setiap kalimat dengan cap, maka cukup ganti
freaddengan "freadFungsi" di mana pun kalimat itu dimulai.sumber
Jika Anda tidak memiliki cara tipografi untuk membedakan (seperti jawaban lain), dan mungkin bahkan jika Anda melakukannya, dapat bermanfaat untuk menunjukkan bahwa Anda berbicara tentang suatu fungsi dengan menggunakan parens:
Ini membantu dengan "menjelaskan" mengapa kata itu tidak dikapitalisasi pada awal kalimat kedua, dan juga membantu (dalam kalimat pertama) untuk memahami mengapa kata benda yang tepat (nama fungsi) tidak dikapitalisasi di sana juga . Sejak (sebagai kata benda yang tepat) itu bisa dibilang seharusnya.
("bisa dibilang" karena kita bisa berdebat apakah fread () adalah kata benda generik atau kata benda yang tepat).
Secara keseluruhan, penggunaan parens membantu otak pembaca memahami mengapa kata-kata aneh muncul dan apa adanya.
sumber
fread()bisa menjadi pernyataan panggilan. Atau bisa juga merujuk ke fungsi kelebihan beban tanpa parameter.func_name()dibaca sebagai "fungsi dengan namafunc_name", terlepas dari apakah fungsi aktual itu sendiri memiliki parameter.f()berarti sesuatu yang berbedaf. Mengapa tidak mengelilingi nama dengan beberapa karakter yang sesuai, mis. Gaya `fread` penurunan harga (itulah yang cenderung saya lakukan dalam pesan komit VCS)? Atau hanya (ketakutan). Tentu saja, hal seperti itu harus dilakukan secara konsisten, tidak hanya untuk fungsi di awal kalimat.Anda dapat memulai kalimat dari deskripsi:
sumber
Anda dapat membandingkan ini dengan inline matematika di publikasi. Anda akan sangat jarang melihat kalimat yang dimulai dengan variabel atau matematika inline lainnya.
Jadi, saya menyimpulkan, Anda harus menghindari nama fungsi di awal kalimat.
Mungkin pertanyaan ini memberikan perincian lebih lanjut: Apakah boleh memulai kalimat dengan huruf Yunani (variabel)? .
sumber
Halaman manual Linux untuk fread (3) yang ditautkan orang lain adalah contoh yang bagus dari empat solusi umum.
man, jika fungsi Anda memiliki halaman manual, lihat bab manual dalam tanda kurung. Jadi "ketakutan (3) perlu kembali ..."Keempat pendekatan ini akan langsung dikenali oleh peretas, dan Anda harus dapat memilih satu yang cocok dengan gaya rumah Anda atau suara pribadi Anda.
Seperti yang Anda katakan, Anda tidak bisa mengandalkan tipografi untuk menyorot nama fungsi Anda. Sintaks Markdown dimaksudkan untuk membuat dokumentasi yang dapat dibaca bahkan ketika juru bahasa markdown tidak tersedia, jadi dengan segala cara mengelilingi nama fungsi Anda dengan sepasang backticks. (Ini, saya kira, kombinasi opsi 2 dan 3.)
Opsi 2 bervariasi sesuai dengan bahasa pemrograman. Misalnya, dokumen Ruby dan Smalltalk sering mendahului nama metode instan dengan hash, seperti #fread . Sementara itu, Lispers mungkin lebih suka nama fungsi kosong, tetapi akan mengerti jika Anda menulis panggilan fungsi kerangka, seperti (fread ...) atau (fread) . Bilas dan ulangi untuk semua bahasa yang Anda dokumentasikan.
sumber
Saya hanya akan menjawab untuk contoh spesifik yang diberikan:
Cukup ganti berhenti penuh pertama (Periode) dengan titik koma:
sumber
Saya tahu ini sudah dijawab, dan jawaban yang diterima cukup bagus, tetapi saya hanya ingin menjelaskan sesuatu.
Dalam tata bahasa Inggris yang tepat, intinya adalah ini: Kadang-kadang kata benda yang tepat diberi nama yang tidak dimulai dengan huruf kapital, dan dalam kebanyakan kasus seperti itu, mereka setiap bit melekat untuk tidak dikapitalisasi sebagai kata benda yang "normal" yang tepat untuk dikapitalisasi. Dalam kasus seperti itu - yang tentunya akan mencakup sebagian besar nama fungsi dalam bahasa C-descended - Anda benar - benar tidak menggunakan huruf besar nama, bahkan di awal kalimat. Sebenarnya, itu adalah tata bahasa dan ejaan bahasa Inggris yang buruk untuk melakukannya. Ini sebenarnya adalah bagian dari prinsip yang sama tentang mengapa itu benar untuk mengeja konsol game Sony "PlayStation", tetapi bukan "Playstation".
Ada kasus-kasus lain di mana kata benda yang tepat tidak seharusnya ditulis dengan huruf besar secara default, namun itu bisa (dan harus) ketika digunakan di awal kalimat. Nama bahasa brainfuck adalah contohnya. Fungsi dalam bahasa C-descended tidak.
myFunc()danMyFunc()dua hal yang sangat berbeda dalam bahasa seperti itu, dan memulai kalimat dengan kata "MyFunc ()" hanya akan merujuk pada yang terakhir, bukan ke yang pertama. Di VB.NET, ini adalah area abu-abu, karena dua fungsi ini akan menjadi hal yang sama dalam bahasa itu, meskipun nama fungsi juga akan mempertahankan skema kapitalisasi yang ditentukan pengguna, pada tingkat tertentu atau yang lain.Juga, meskipun aturan bahasa Inggris ditetapkan dalam kasus ini, mereka cenderung agak kabur tentang hal-hal seperti ini sebagai aturan. Bahasa Inggris tidak dirancang dengan hal-hal seperti ini dalam pikiran, jadi untuk hal-hal lain seperti ini, ada ruang untuk improvisasi.
sumber