İşlev ismiyle bir cümle mi başlıyorsunuz? [kapalı]

42

Bazen büyük / küçük harfe duyarlı bir programlama dili ile ilgili bir şeyler yazarken, fonksiyon ismiyle bir cümle başlatıyorum. Şimdi İngilizce kuralları, bir cümle içindeki ilk kelimenin büyük harfle yazılması gerektiğini; işlev adı küçük harf olsa da. İlk kelimenin bir işlev adı olmasına neden olacak ne diyebileceğimi merak ediyorsanız, bu örneği alın:

Gerçek uygulamanız bozuldu. fread kaç byte okunduğunu döndürmek istiyor.

Ben ikinci örneğini değişebilir anlıyoruz freadla için It ama sadece cümle yeniden yazmaktan daha bu diğer işleme en iyi yolu bilmek istiyorum. İşlev adını büyük harf yapmalı mıyım? Cevap olarak "cümleyi yeniden yaz" ifadesini duymak istediğim tek yol, cümleyi bir işlev adıyla başlatmanın farkında olmadığım bazı İngilizce kurallarını ihlal etmesidir. Düzenleme: Bu cevaplar için herkese gerçekten teşekkür ederim. Konuyla ilgili görüşümü değiştirdiler ve geliştirdiler. Bundan epeyce öğrendim. Bu basit ama iyi çözümler hakkında düşünmediğim için çok şaşırdım.

Cümle değiştirme konusundaki duruşumun çok zor olduğunu düşünüyorum ve şimdi cümle değiştirmenin genel olarak parantez eklemeden veya fonksiyondan önce parantez ekleyerek bu davalarla başa çıkmak için en iyi seçenek gibi göründüğü için bu iyi cevaplar olduğunu anlıyorum. işlev ismi ve işlev ismi için biçimlendirme kullanılıyorsa kullanılabilir.

functions

— user3462295
kaynak

1

@gnat Bir şeye ne ad vereceğimi sormuyorum, bir cümleye işlev adıyla nasıl başlayacağımı soruyorum.

— user3462295

13

Matematikte, bir cümleyi değişken bir isimle veya formülle başlatmaktan kaçınması gereken bir kural vardır. Buna rağmen, değişkenlerin ve formüllerin italik olarak metinlerden çıkarılması için oluşturuldukları tipografik bir sözleşmemiz olmasına rağmen. Biri " x'in gücü 2 olsun. X pozitif, öyleyse ..." yazmaktan kaçınırdı. Her zamanki düzeltme bazı dolgu kelimelerini yeniden yazmak veya eklemektir: "Şimdi x pozitif" veya "Biz x'in pozitif olduğu" veya çeşit bir şey.

— Nate Eldredge

9

Bir programlama dilinden gelen bir tanımlayıcı, yabancı bir kelime olarak değerlendirilmeli ve aynı İngilizce kurallarına tabi olmamalıdır.

— Rufflewind

1

İngilizce üzerine bazı aktif olarak aktif programcılar var.SE ( tchrist ... pek Eric Lippert değil ) - ama istediğiniz cevap türüne bağlı. Bunu programcı odaklı bir siteye programcı olarak yazıyoruz. Teknik yazımın formaliteleri, dergi kuralları ve uygun İngilizce cümle yapılarıyla daha fazla ilgileniyorsanız, hedef uzman kitlenizi yeniden gözden geçirmek isteyebilirsiniz.

2

Bu soru konu dışı gibi görünüyor çünkü İngilizce ve kullanım dili ve bunun için tüm StackExchange sitemiz var. Gerçekten de, orada en az dört benzer soru var . Ayrıca, farklı cevaplar yazının nerede olduğuna vb. Bağlı olarak eşit olarak geçerli olabilir.

— Caleb

87

Tipografide bu, genellikle bir cümlenin başlangıcı olsun veya olmasın, farklı bir imgeleme kullanılarak ele alınır; göze çarpan şeyin sadece cümle içindeki bir kelime değil, özel bir varlık olduğunu belirtmek için kullanılır.

Sizin freaduygulaması bozuldu. freadkaç bayt okunduğunu döndürmek gerekiyor.

Bir belgenin ne kadar resmi olduğuna bağlı olarak, aynı yaklaşımı benimseyebilir. Her halükarda, bunu tanımladığınız sorunu ortadan kaldırır, bu yüzden bunu sadece bu nedenle kullanmak isteyebilirsiniz.

Düz metin dünyasında (yorumlarda ve diğer cevaplarda da belirtildiği gibi), işlev adlarına parantez eklemek biraz yardımcı olur, ancak parantez almayan öğelere de başvurmamız gerektiğinden, bunun yalnızca sınırlı bir değeri vardır. Genel olarak, metni köşeli parantez ve yıldız gibi özel karakterlerle çevreleyen bir sözleşmeyi kabul etmek yerine, düz metin dünyasında cümleyi yeniden yapılandırarak konuyu gözden kaçırmak için çok az seçenek vardır.

— Reg Düzenleme
kaynak

Evet, amacınızı anlıyorum, hala garip ama daha az garip görünüyor. Ancak, duyguların her zaman gramer ve yazı kurallarına uygun olmadığını anlıyorum. Bunu yapmanın daha iyi bir yolu olup olmadığından emin değilim, bu yüzden biri daha iyi bir şey bulamazsa cevabınızı kabul edeceğim.

— user3462295

25

Sık sık böyle şeyler için italikleştiriyorum - her zaman büyük / küçük harf duyarlı terimlerin mahremiyetini korumalısınız, bir cümle nerede olduklarından bağımsız olarak, IMO. freadbir kelime değil; bir varlığı temsil eden bir semboldür. Dilbilgisine tabi değil.

— Ant P

4

Ve ... düz metinlerle uğraşmak zorunda kalırsan ne yaparsın? Küçük bir .txt yardım dosyasındaki veya düz metin e-postasındaki gibi mi? Cevabınıza bu senaryoyu da eklemenizi öneririm.

— Ellesedil

2

@Ellesedil Bu durumda, genellikle onu bir işlev olduğunu belirtmek için ()veya ile eklerim (...). Ancak bu, her zaman, özellikle değişkenlerle ve bununla uğraşırken işe yaramaz. O zaman yaptığım, `kodunu belirtmek için adı (onay karakteri) ile sarmaktır.

— Cole Johnson

4

@Ellesedil Kod elemanları belirtmek için markdown sözdizimini, yorumlar gibi düz metin bağlamlarında bile kullanmaya başladım. Düz İngilizceyi yazarken backtick sembolü kullanmak için ihtiyacım olan tek zamandı.

— Keen

53

Her cümleyi bir başlık ile başlatmak için mutlak bir gereklilik varsa, o zaman bir cümleyi başlattığı yerde fread" freadİşlev" ile değiştirin .

— X-kod
kaynak

21

Ayırt etmek için tipografik araçlarınız yoksa (başka bir cevaba göre) ve belki de yapsanız bile, parens kullanarak bir işlevden bahsettiğinizi belirtmek yararlı olabilir:

Fread () uygulamanız bozuldu. fread (), kaç bayt okunduğunu döndürmelidir.

Bu ikinci cümlenin başında aktifleştirilir değil niçin "açıklayan" ile yardımcı olur ve aynı zamanda özel isim (bir işlev adı) orada büyük harfle değil anlamak için (ilk cümlede) yardımcı olur ya . Çünkü (uygun bir isim olarak) tartışmalı olmalıydı.

("tartışmalı" çünkü fread () 'in genel bir isim veya uygun bir isim olduğunu iddia edebiliriz).

Genel olarak, parens kullanımı, okuyucunun beyninin neden garip kelimelerin ortaya çıktığını ve ne olduklarını anlamalarına yardımcı olur.

— GreenAsJade
kaynak

5

Parens kullanmak, metnin fazlalığını azaltmaya da yardımcı olur. "İşlev fread" yerine sadece "fread ()" diyebilirsiniz. Ayrıca değişken isimleri ve fonksiyonlar gibi şeyler arasındaki farkı vurgulamak için bir çeşit vurgulamanın olması da yararlıdır.

— Paul92

3

Bence parantez sadece daha fazla karışıklık ekler. fread()Bir çağrı ifadesi olabilir. Veya parametresiz aşırı yüklenmiş bir fonksiyona atıfta bulunabilir.

— kapex

4

@kapep Genel olarak, koddan bahseden belgelerde , asıl işlevin kendisinin herhangi bir parametresi olup olmadığına bakılmaksızın, " func_name()adına göre bir işlev" olarak okunur func_name.

— Eric Finn

3

@EricFinn Tecrübelerime göre genellikle parametresiz fonksiyonları ifade eder, ancak kesinlikle dile ve sözleşmelerine bağlıdır. Örneğin, resmi Java yorum kuralları parantez kullanımını engeller: "[yöntemin belirli bir biçimine] bakarken, parantez ve bağımsız değişken türlerini kullanın. [...] Ancak, yöntemin her iki biçimine de atıfta bulunma parantezler tamamen boş parantezleri içermek yanıltıcıdır, çünkü bu, " oracle.com/technetwork/java/javase/documentation/…

— kapex

3

Görsel bir ipucu eklemek kesinlikle iyi bir fikir olsa da (en iyisi özel bir yazı tipi olmak ya da başka bir şey vurgulamaktır), ben boş bir paren eklemenin gerçekten sorunlu bir seçenek olduğunu kabul ediyorum, çünkü bildiğim her dilde f()farklı bir şey ifade ediyor f. Neden ismi bazı uygun karakterlerle çevreleyen , örneğin markdown tarzı `fread '(VCS taahhüt mesajları yapma eğilimindeyim)? Ya da basitçe (fread). Tabii ki, böyle bir şey sadece bir cümlenin başındaki fonksiyonlar için değil, tutarlı bir şekilde yapılmalıdır.

— leftaroundabout

10

Cümleyi açıklamadan başlatabilirsiniz:

İşlevi fread[…]

Yöntem fread[…]

Mülkiyet breadColor[…]

— David Sergey
kaynak

@Zack: Başkan Obama.

— Marc van Leeuwen

@MarcvanLeeuwen Başlıklar özel bir durumdur. (Ayrıca "Kraliçe Elizabeth", "Bay Rogers".) Kafamın üstünden uygun bir analizim yok, ama sezgisel olarak bir kategori etiketi yerine adın bir parçası olarak kabul edildiklerini düşünüyorum.

— zwol

8

Bunu yayınlarda satır içi matematiğe benzetebilirsiniz. Değişken veya başka bir satır içi matematikle başlayan cümleleri çok nadiren göreceksiniz.

Bu nedenle, bir cümlenin başında fonksiyon adlarından kaçınmanız gerektiği sonucuna varıyorum.

Belki bu soru daha fazla ayrıntı sunar: Bir Yunanca harfle (değişken) bir cümle başlatmak uygun mudur? .

— Lukas
kaynak

3

+1. In Matematiksel İspat (Chartrand vd., 2000), kimin Bölüm 0 matematiksel yazma için iyi bir tavsiye gerçek memba altında ilk kural Sembolleri Kullanarak "Hiç bir sembolle bir cümle başlar." Dır (Örnek, bir denklemle başlayan bir cümledir; yazarlar, "denklem ___" ile önyüklenmesini önermektedir.) Tüm matematiksel yazım önerileri, kaynak kod hakkında yazmak için mutlaka geçerli olmamakla birlikte, bunun bir bit olduğunu düşünüyorum.

— ruakh

1

Ben analojiyle aynı fikirde olduğuma emin değilim. $ X $ gibi semboller bir denklemde geçicidir, bu yüzden onlara küresel bir anlamı varmış gibi atıfta bulunmak çok garip. $ \ Pi $ gibi bir sembol cümle başlatırsa, okuyucu olarak rahat hissederim.

— djechlin

1

@djechlin Bir cümleyi bir sembolle başlatmanın küresel bir anlamı olduğu ya da aslında bununla ilgisi olduğu anlamına geldiğinden emin değilim.

— Kyle Strand

@KyleStrand, neden bir cümleyi hiç bir zaman asla bir sembolle başlatmaman gerektiğini bilmek güzel olurdu. "$ \ pi $ is ..." v. "$ \ pi $ matematiksel sabiti ..." - siz seçin.

— djechlin

1

@djechlin: Bunun bir nedeni, önceki cümlenin matematikle bitmesi durumunda, aşağıdaki cümlenin başlangıcındaki matematiğin, aralarında bir nokta bulunan aynı formülün bir parçası gibi görünmesidir. (Bu virgüllerde daha da büyük bir sorun.) Başka bir konu, değişken isimleri genellikle küçük harf olduğundan, okuyucunun gözünün bir sonraki cümlenin başını bulmak için büyük harf aramanın görsel işaretini kaybetmesidir.

— Nate Eldredge

3

Diğerlerinin birbirine bağlandığı fread (3) için Linux sayfası , dört ortak çözüme güzel bir örnektir.

Cümleniz "foo işlevi" veya "foo işlevi" ile başlar. Msgstr "İşlev fread'in geri dönmesi gerekiyor ..." .
Programlama dili topluluğunuz tarafından kullanılan sözleşmeye göre ekstra karakterlerle işlev adını işaretleyin. C durumunda, boş bir parantez çifti, yani "fread () 'ın geri dönmesi gerekir ..." .
İşlev adını vurgulamak için tipografiyi (kalın, sabit genişlikli karakterler veya italik) kullanın: " fread geri dönmeli ..."
Kullanan sistemlerde man, eğer fonksiyonunuzun bir man sayfası varsa, el kitabında parantez içindeki bölümüne bakın. Yani "fread (3) geri dönmeli ..."

Dört yaklaşımın tamamı bilgisayar korsanları tarafından anında tanınabilir ve ev tarzınıza veya kişisel sesinize uygun olanı seçebilmelisiniz.

Dediğiniz gibi, fonksiyon adınızı vurgulamak için tipografiye güvenemezsiniz. Markdown'ın sözdizimi, bir markdown yorumlayıcısı kullanılmadığında bile okunabilir bir dokümantasyon yapmak anlamına gelir, bu nedenle elbette, işlev adınızı bir çift geri tepme ile çevreleyin. (Bu, sanırım, seçenek 2 ve 3'ün bir birleşimidir.)

Seçenek 2, programlama diline göre değişir. Örneğin, Ruby ve Smalltalk belgeleri genellikle #fread gibi bir eşleme ile örnek yöntem adlarından önce gelir . Bu arada, Lispers işlev adının çıplak olmasını tercih edebilir, ancak (fread ...) veya (fread) gibi bir iskelet fonksiyon çağrısı yazarsanız anlar . Durulayın ve belgelenen tüm diller için tekrarlayın.

— dcorking
kaynak

Cevabını beğendim. Böyle yapmak fonksiyonlar hakkında yazmak daha iyi görünmesini sağlar.

— user3462295

2

Sadece verilen belirli örnek için cevap vereceğim:

Gerçek uygulamanız bozuldu. fread kaç byte okunduğunu döndürmek istiyor.

Sadece ilk tam durağı (Periyot) noktalı virgülle değiştirin:

Gerçek uygulamanız bozuldu; fread kaç byte okunduğunu döndürmek istiyor.

— EdHunter
kaynak

3

Hayır! bu bir kaçınılmaz cümle ya da virgül eki yapacaktır. Çok zayıf dilbilgisi. Bir noktalı virgül Tamam olur.

— Martin McCallion

Yani virgül kullanmak her zaman işe yaramaz; ama neden virgül kullanıyorsunuz?

— reinierpost

Bu virgül değil. Bu bir noktalı virgül; bunda noktalı virgül kullanımı.

— RubberDuck

1

Kişisel olarak burada noktalı virgül yerine iki nokta üst üste kullanırdım (her ne kadar noktalı virgülle de iyi okunsa da).

— Marc van Leeuwen

0

Bunun zaten cevaplandığını biliyorum ve kabul edilen cevap oldukça iyi, ama sadece bir şeyi açıklığa kavuşturmak istiyorum.

Düzgün İngilizce dilbilgisi, alt satırda şudur: Bazen uygun isimlere büyük harfle başlamamış isimler verilir ve çoğu durumda, "normal" uygun isimler olarak büyük harfle yazılmamasına bağlı her biti vardır. kapitalize edilmek. Kesinlikle C soyundan dilde en işlev adlarını içerir - - Bu gibi durumlarda kesinlikle yok hatta bir cümlenin başında, adını yararlanmak. Aslında, kötü İngilizce gramer ve bunu yapmak için yazım. Bu aslında Sony'nin oyun konsolu "PlayStation" ı hecelemenin neden doğru olduğu ile aynı prensibin bir parçası ama "Playstation" değil.

Uygun bir ismin varsayılan olarak büyük harfle yazılmaması gereken başka durumlar da vardır ve bir cümlenin başında kullanıldığında yine de olabilir (ve olmalıdır). Beynin dilinin adı buna bir örnektir. C iniş dilindeki işlevler değildir. myFunc()ve MyFunc()bu gibi dillerde birbirinden tamamen farklı iki şey var ve "MyFunc ()" kelimesiyle bir cümle başlatmak, birincisine değil, sadece ikinciye atıfta bulunacak. Yine de VB.NET'te bu gri bir alandır, çünkü bu iki işlev aynı dilde aynı olacaktır, ancak işlev adları aynı zamanda bir düzeyde ya da başka bir kullanıcı tarafından belirtilen büyük harf kullanım planlarını koruyacaktır.

Ayrıca, bu durumda İngilizce kurallar taş olmasına rağmen, kural olarak bu gibi şeyler etrafında biraz puslanma eğilimindedirler. İngilizce bu gibi şeyler düşünülerek tasarlanmadı, bu yüzden böyle şeyler için doğaçlamaya yer var.

— Panzercrisis
kaynak