Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

Comment

class in Unity.Localization


Implements interfaces:IMetadata

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Stores a free-text author comment that can be attached to any localization target.

A comment can hold any information, but it is most useful for giving translators context about an entry. It implements IMetadata, so it is stored in a MetadataCollection. The MetadataAttribute on this type allows it on every target and limits each target to a single comment.

Additional resources: IMetadata, MetadataCollection, MetadataAttribute, ExcludeEntryFromEditorExport

Attach a comment to a metadata collection.

using Unity.Localization;

namespace Unity.Localization.Samples { public class CommentExample { public void Run(MetadataCollection metadata) { metadata.AddMetadata(new Comment { CommentText = "Keep under 20 characters." }); } } }

Properties

Property Description
CommentText The comment text.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961