Memulai kalimat dengan nama fungsi? [Tutup]

42

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.

functions

— pengguna3462295
sumber

1

@gnat Saya tidak menanyakan nama apa, saya bertanya bagaimana memulai kalimat dengan nama fungsi.

— user3462295

13

Ada konvensi terkait dalam matematika bahwa seseorang harus menghindari memulai kalimat dengan nama variabel atau rumus. Ini terlepas dari kenyataan bahwa kami memiliki konvensi tipografis bahwa variabel dan formula dibuat miring untuk memisahkannya dari teks. Orang akan menghindari menulis "Biarkan x menjadi kekuatan 2. x adalah positif, jadi ..." Perbaikan yang biasa adalah dengan menguraikan kembali atau menambahkan beberapa kata pengisi: "Sekarang x adalah positif" atau "Kami memiliki bahwa x adalah positif" atau semacam itu.

— Nate Eldredge

9

Pengidentifikasi dari bahasa pemrograman harus diperlakukan sebagai kata asing dan tidak boleh tunduk pada aturan bahasa Inggris yang sama.

— Rufflewind

1

Ada beberapa programmer yang sangat aktif menggunakan Bahasa Inggris. SE ( tchrist ... tidak begitu banyak Eric Lippert ) - tetapi itu tergantung pada jenis jawaban yang Anda inginkan. Kami menulis ini sebagai pemrogram di situs yang berfokus pada pemrogram. Jika Anda lebih tertarik pada formalitas penulisan teknis, pedoman jurnal, dan struktur kalimat bahasa Inggris yang tepat, Anda mungkin ingin mempertimbangkan kembali audiens ahli target Anda.

2

Pertanyaan ini tampaknya di luar topik karena bahasa Inggris dan penggunaannya, dan kami memiliki seluruh situs StackExchange untuk itu. Memang, setidaknya ada empat pertanyaan serupa di sana . Juga, jawaban yang berbeda mungkin sama-sama valid tergantung di mana tulisan itu muncul, dll.

— Caleb

87

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.

— Sunting Reg
sumber

Ya saya melihat maksud Anda, itu masih jatuh canggung tetapi kurang canggung. Namun saya mengerti bahwa perasaan tidak selalu sejalan dengan aturan tata bahasa dan tulisan. Saya tidak yakin apakah ada cara yang lebih baik untuk menangani hal ini, jadi saya akan menerima jawaban Anda kecuali seseorang menemukan sesuatu yang lebih baik.

— user3462295

25

Saya sering kali menuliskan huruf miring untuk hal-hal seperti ini - Anda harus selalu menjaga casing dengan istilah case-sensitive, di mana pun mereka berada dalam kalimat, IMO. freadbukan sebuah kata; itu adalah simbol yang mewakili suatu entitas. Itu tidak tunduk pada tata bahasa.

— Ant P

4

Dan ... apa yang Anda lakukan jika Anda harus berurusan dengan teks biasa? Seperti di file bantuan .txt kecil, atau email teks biasa? Saya sarankan menyertakan skenario itu juga untuk jawaban Anda.

— Ellesedil

2

@ Ellesedil Dalam hal ini, saya biasanya akan suffix dengan ()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.

— Cole Johnson

4

@ Ellesedil Saya telah menggunakan sintaks markdown untuk menunjukkan elemen kode, bahkan dalam konteks teks biasa seperti komentar. Ini satu-satunya waktu saya pernah perlu menggunakan simbol backtick saat menulis bahasa Inggris.

— Tertarik

53

Jika ada persyaratan mutlak untuk memulai setiap kalimat dengan cap, maka cukup ganti freaddengan " freadFungsi" di mana pun kalimat itu dimulai.

— kode-x
sumber

21

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:

Implementasi fread () Anda rusak. fread () perlu mengembalikan berapa byte yang dibaca.

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.

— GreenAsJade
sumber

5

Menggunakan parens juga membantu mengurangi redundansi teks. Alih-alih "function fread" Anda bisa mengatakan hanya "fread ()". Dan itu juga berguna jika Anda memiliki semacam penyorotan untuk menekankan perbedaan antara hal-hal seperti nama variabel dan fungsi.

— Paul92

3

Saya pikir kurung hanya menambah lebih banyak kebingungan. fread()bisa menjadi pernyataan panggilan. Atau bisa juga merujuk ke fungsi kelebihan beban tanpa parameter.

— kapex

4

@kapep Umumnya dalam dokumen yang mengacu pada kode, func_name()dibaca sebagai "fungsi dengan nama func_name", terlepas dari apakah fungsi aktual itu sendiri memiliki parameter.

— Eric Finn

3

@ EricFinn Menurut pengalaman saya, ini biasanya merujuk pada fungsi tanpa parameter, tapi itu tergantung pada bahasa dan konvensi. Misalnya, pedoman komentar resmi Java tidak menyarankan penggunaan tanda kurung: "Ketika merujuk ke [bentuk spesifik dari suatu metode], gunakan tanda kurung dan tipe argumen. [...] Namun, jika merujuk ke kedua bentuk metode, hilangkan sama sekali kurung. Menyesatkan untuk menyertakan tanda kurung kosong, karena itu akan menyiratkan bentuk khusus dari metode " oracle.com/technetwork/java/javase/documentation/…

— kapex

3

Sementara menambahkan petunjuk visual tentu saja merupakan ide yang baik (yang terbaik adalah font khusus atau highlight), saya setuju dengan kapep bahwa menambahkan parens kosong adalah pilihan yang sangat bermasalah, karena dalam setiap bahasa yang saya tahu f()berarti sesuatu yang berbeda f. 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.

— leftaroundabout

10

Anda dapat memulai kalimat dari deskripsi:

Fungsi fread[...]

Metode fread[...]

Properti breadColor[...]

— David Sergey
sumber

@Zack: Presiden Obama.

— Marc van Leeuwen

@MarcvanLeeuwen Judul adalah kasus khusus. (Juga "Ratu Elizabeth", "Tuan Rogers".) Saya tidak memiliki analisis yang tepat dari atas kepala saya, tetapi secara intuitif saya pikir mereka dianggap bagian dari nama daripada tag kategori.

— zwol

8

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)? .

— Lukas
sumber

3

+1. Dalam Bukti Matematika (Chartrand et al., 2000), yang Bab 0 adalah sumber nyata yang baik untuk penulisan matematika, aturan pertama di bawah Menggunakan Simbol adalah "Jangan pernah memulai kalimat dengan simbol." (Contohnya adalah kalimat yang dimulai dengan persamaan; penulis menyarankan untuk membuatnya dengan "Persamaan ___".) Meskipun tidak semua saran penulisan matematis berlaku untuk menulis tentang kode sumber, saya pikir ini adalah sedikit yang melakukannya.

— ruakh

1

Saya tidak yakin saya setuju dengan analoginya. Simbol seperti $ x $ bersifat sementara untuk sebuah persamaan sehingga aneh untuk menyebutnya seolah-olah mereka memiliki makna global. Jika simbol seperti $ \ pi $ memulai kalimat, saya akan merasa nyaman sebagai pembaca.

— djechlin

1

@djechlin Saya tidak yakin memulai kalimat dengan simbol menyiratkan bahwa kalimat itu memiliki makna global, atau sebenarnya ada hubungannya dengan itu.

— Kyle Strand

@KyleStrand akan menyenangkan untuk mengetahui mengapa Anda tidak boleh memulai kalimat dengan simbol. "$ \ pi $ is ..." v. "Konstanta matematika $ \ pi $ adalah ..." - Anda pilih.

— djechlin

1

@djechlin: Salah satu alasannya adalah jika kalimat sebelumnya diakhiri dengan matematika, matematika pada awal kalimat berikut ini mungkin terlihat seperti bagian dari rumus yang sama dengan titik di antaranya. (Ini bahkan lebih merupakan masalah dengan koma.) Masalah lain adalah bahwa karena nama variabel biasanya huruf kecil, mata pembaca kehilangan isyarat visual mencari huruf kapital untuk menemukan awal kalimat berikutnya.

— Nate Eldredge

3

Halaman manual Linux untuk fread (3) yang ditautkan orang lain adalah contoh yang bagus dari empat solusi umum.

Mulailah kalimat Anda dengan "Fungsi foo" atau "Fungsi foo". "Fungsi ketakutan harus kembali ..." .
Tandai nama fungsi dengan karakter tambahan sesuai dengan konvensi yang digunakan oleh komunitas bahasa pemrograman Anda. Dalam kasus C, sepasang kurung kosong, jadi "fread () harus mengembalikan ..." .
Gunakan tipografi (tebal, karakter lebar tetap atau miring) untuk menyorot nama fungsi, seperti: " ketakutan perlu kembali ..."
Pada sistem yang menggunakan 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.

— bekerja
sumber

Saya suka jawaban Anda. Melakukan hal itu membuat penulisan tentang fungsi terlihat lebih baik.

— user3462295

2

Saya hanya akan menjawab untuk contoh spesifik yang diberikan:

Implementasi ketakutan Anda rusak. fread perlu mengembalikan jumlah byte yang dibaca.

Cukup ganti berhenti penuh pertama (Periode) dengan titik koma:

Implementasi ketakutan Anda rusak; fread perlu mengembalikan jumlah byte yang dibaca.

— EdHunter
sumber

3

Tidak! itu akan membuatnya menjadi kalimat run-on atau splice koma. Tata bahasanya sangat buruk. Titik koma akan baik-baik saja.

— Martin McCallion

Jadi menggunakan koma tidak selalu berhasil; tapi mengapa menggunakan koma?

— reinierpost

Itu bukan koma. Ini adalah titik koma; penggunaan yang tepat dari titik koma pada saat itu.

— RubberDuck

1

Saya pribadi akan menggunakan titik dua di sini alih-alih tanda titik koma (meskipun itu terbaca juga dengan titik koma).

— Marc van Leeuwen

0

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()dan MyFunc()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.

— Panzercrisis
sumber