blocks|key|1341509|text|如果我能帮上忙的话:)|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1341510|从这个角度来思考--技术文档的目的是什么？|1341511|权利--交流一些技术性的东西|1341512|现在想象一下，你在听别人向你解释一些你很难理解的事情--他们不会停下来，他们不会停下来，信息涌入你的大脑比你能接受的更快，你最终什么都不做。|1341513|阅读也是如此--信息太多而不间断，读者通常要么跳过它而没有正确阅读，要么反复阅读这句话，直到他们能够一次把它全部记在脑中，并理解它。|1341514|别这样对你的读者！设身处地地为他们着想--按你的意愿来写吧。|1341515|简短、简洁的句子是最好的--你不是在写散文。|entityMap^0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|O|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|P|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|Q|8|@]|9|@]|A|$]]|$1|F|3|G|5|6|7|R|8|@]|9|@]|A|$]]|$1|H|3|I|5|6|7|S|8|@]|9|@]|A|$]]|$1|J|3|K|5|6|7|T|8|@]|9|@]|A|$]]|$1|L|3|M|5|6|7|U|8|@]|9|@]|A|$]]]|N|$]]

Not if I can help it :)

Think about it this way - what is the purpose of technical documents?

Right - to communicate something technical - and possibly quite involved/complex.

Now imagine you are listening to someone explain something to you that you are struggling to follow - they don't stop, they don't pause, information is flooding into your brain faster than you can take it in, you end up following nothing.

It's the same with reading - too much information without a break, and the reader will generally either skip it without having read it properly, or repeatedly read that sentence until they can finally hold it all in their heads at once and understand it.

Don't do this to your readers! Put yourself in their shoes - write it as you would wish to read it.

Short, succint sentences are best - you're not writing prose.

blocks|key|1341558|text|不幸的是，在包括程序员在内的许多技术人员中，优秀的写作技巧似乎并不多见。好处是，只要在提高你的写作技巧上投入一点钱，你就会脱颖而出。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|entityMap^0^^$0|@$1|2|3|4|5|6|7|C|8|@]|9|@]|A|$]]]|B|$]]

Unfortunately good writing skills appear to be rare among many technical people including programmers. The bonus is that with a little investment in improving your writing skills will make you stand out.

blocks|key|1341616|text|考虑到这一点：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1341617|A+single+40-word+sentence+that+someone+reads+4+times+before+comprehending+it+that+too+with+some+doubts+and+in+the+end+the+sentence+is+ignored+because+"there+are+more+to+follow"...|code-block|syntax|javascript|1341618|另一种选择：|1341619|Four+10-word+sentences.+
Understandable+in+(at+most)+2+readings.+
Reader's+happy+and+of+course,+understands+what+you+wrote.|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|M|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|N|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|O|8|@]|9|@]|A|$E|F]]]|K|$]]

Consider this: 

<pre><code>A single 40-word sentence that someone reads 4 times before comprehending it that too with some doubts and in the end the sentence is ignored because "there are more to follow"...
</code></pre>

Another alternative: 

<pre><code>Four 10-word sentences. 
Understandable in (at most) 2 readings. 
Reader's happy and of course, understands what you wrote.
</code></pre>

blocks|key|1341545|text|把更多的技术信息打包成一个句子比创建多个小句子好吗?每个句子都有一点点技术信息吗？|type|blockquote|depth|inlineStyleRanges|entityRanges|data|1341546|在某种程度上，这是一个与语言有关的问题。从英语的角度来看，虽然在德语中有更多的空间，但过载句子的做法通常很差。|unstyled|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|F|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|G|8|@]|9|@]|A|$]]]|E|$]]

<blockquote>
 Is packing more technical information into one sentence better than creating many little sentences each with a little bit of technical information?
</blockquote>

To some extent, this is a language dependent question. From the point of view of English, it's generally very poor practice to overload sentences although there is some more scope in, for example, German.

blocks|key|5079699|text|考虑提供信息的其他方式，以提高清晰度。例如：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|5079700|尝试球杆点|unordered-list-item|5079701|📷|atomic|offset|length|5079702|(我理解图片在代码注释中可能很难使用)|entityMap|0|IMAGE|mutability|IMMUTABLE|imageUrl|https://i.stack.imgur.com/3ZXmr.png|imageAlt^0|0|0|0|1|0|0^^$0|@$1|2|3|4|5|6|7|T|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|U|8|@]|9|@]|A|$]]|$1|E|3|F|5|G|7|V|8|@]|9|@$H|W|I|X|1|Y]]|A|$]]|$1|J|3|K|5|6|7|Z|8|@]|9|@]|A|$]]]|L|$M|$5|N|O|P|A|$Q|R|S|-4]]]]

Consider other ways of presenting the information to promote clarity. For example:

<ul>
<li>Try bulleted points</li>
</ul>

<img src="https://i.stack.imgur.com/3ZXmr.png" alt="try using a picture">

(I appreciate that pics may be hard to use in code comments)

This is just a question to think about.

When you write technical documentation and programming comments, do you ever find yourself writing run-on sentences in order to be more precise?

Is packing more technical information into one sentence better than creating many little sentences each with a little bit of technical information?

I know it's better to have lots of little classes in their own little files. Perhaps this doesn't apply to writing?

Run On Sentences in Technical Writing

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云AI代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

功能1上新10个字符

功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符。

功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符。

功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符

功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符

功能4上新

文章&问答评论现已支持表情

全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

社区富文本编辑器全新改版！诚邀体验～ 

精选全网热门MCP server，让你的AI更好用 🚀

💥开发者 MCP广场重磅上线！

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

这只是一个需要思考的问题。当你写技术文档和编程注释时，你有没有发现自己为了更精确地写一些连续的句子？把更多的技术信息打包成一个句子比创建多个小句子好吗?每个句子都有一点点技术信息吗？我知道最好在自己的小文件里有很多小班。也许这不适用于写作？

问技术写作中的句子运行
EN

回答 5

Software Engineering用户

Software Engineering用户

Software Engineering用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问技术写作中的句子运行EN

回答 5

Software Engineering用户

Software Engineering用户

Software Engineering用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问技术写作中的句子运行
EN